#
# import modules path
#
import os, sys
try:
import webnotes.defs
m = getattr(webnotes.defs,'modules_path',None)
m and sys.path.append(m)
except Exception,e:
raise e
#
# map for identifying which field values come from files
#
code_fields_dict = {
'Page':[('script', 'js'), ('content', 'html'), ('style', 'css'), ('static_content', 'html'), ('server_code', 'py')],
'DocType':[('server_code_core', 'py'), ('client_script_core', 'js')],
'Search Criteria':[('report_script', 'js'), ('server_script', 'py'), ('custom_query', 'sql')],
'Patch':[('patch_code', 'py')],
'Stylesheet':['stylesheet', 'css'],
'Page Template':['template', 'html'],
'Control Panel':[('startup_code', 'js'), ('startup_css', 'css')]
}
#
# globals
#
#: "v170"
version = 'v170'
form_dict = {}
auth_obj = None
#: The database connection :class:`webnotes.db.Database` setup by :mod:`auth`
conn = None
#: The cgi.FieldStorage() object (Dictionary representing the formdata from the URL)
form = None
session = None
"""
Global session dictionary.
* session['user'] - Current user
* session['data'] - Returns a dictionary of the session cache
"""
user = None
is_testing = None
""" Flag to identify if system is in :term:`Testing Mode` """
incoming_cookies = {}
add_cookies = {}
""" Dictionary of additional cookies appended by custom code """
cookies = {}
auto_masters = {}
tenant_id = None
from webnotes.utils import cstr
#
# Custom Class (no traceback)
#
class ValidationError(Exception):
pass
#
# HTTP standard response
#
response = {'message':'', 'exc':''}
"""
The JSON response object. Default is::
{'message':'', 'exc':''}
"""
#
# the logs
#
debug_log = []
""" List of exceptions to be shown in the :term:`Error Console` """
message_log = []
""" List of messages to be shown to the user in a popup box at the end of the request """
def getTraceback():
import webnotes.utils
return webnotes.utils.getTraceback()
def errprint(msg):
"""
Append to the :data:`debug log`
"""
debug_log.append(cstr(msg or ''))
def msgprint(msg, small=0, raise_exception=0, as_table=False):
"""
Append to the :data:`message_log`
"""
if as_table and type(msg) in (list, tuple):
msg = '
' + ''.join([''+''.join(['%s | ' % c for c in r])+'
' for r in msg]) + '
'
message_log.append((small and '__small:' or '')+cstr(msg or ''))
if raise_exception:
raise ValidationError
def is_apache_user():
import os
if os.environ.get('USER') == 'apache':
return True
else:
return (not os.environ.get('USER'))
# os.environ does not have user, so allows a security vulnerability,fixed now.
def get_index_path():
import os
return os.sep.join(os.path.dirname(os.path.abspath(__file__)).split(os.sep)[:-2])
def get_files_path():
global conn
import defs, os
if not conn:
raise Exception, 'You must login first'
if defs.files_path:
return os.path.join(defs.files_path, conn.cur_db_name)
else:
return os.path.join(get_index_path(), 'user_files', conn.cur_db_name)
def create_folder(path):
"""
Wrapper function for os.makedirs (does not throw exception if directory exists)
"""
import os
try:
os.makedirs(path)
except Exception, e:
if e.args[0]==17:
pass
else:
raise e
def connect(db_name):
"""
Connect to this db (or db), if called from command prompt
"""
if is_apache_user():
raise Exception, 'Not for web users!'
import webnotes.db
global conn
conn = webnotes.db.Database(db_name=db_name)
global session
session = {'user':'Administrator'}
import webnotes.profile
global user
user = webnotes.profile.Profile('Administrator')
# Environment Variables
#-----------------------------------------------------------
def get_env_vars(env_var):
return os.environ.get(env_var,'None')
remote_ip = get_env_vars('REMOTE_ADDR') #Required for login from python shell
# Logging
# -----------------------------------------------------------
logger = None
def setup_logging():
import logging
import logging.handlers
# Also please set umask for apache to 002.
global logger
try:
logger = logging.getLogger('WNLogger')
logger.setLevel(eval(defs.log_level))
log_handler = logging.handlers.RotatingFileHandler(defs.log_file_name, maxBytes = defs.log_file_size, backupCount = defs.log_file_backup_count)
formatter = logging.Formatter('%(name)s - %(asctime)s - %(levelname)s\n%(message)s\n-------------------')
log_handler.setFormatter(formatter)
logger.addHandler(log_handler)
except IOError,e:
if e.args == 13:
open(defs.log_file_name).close()
if getattr(defs, 'log_file_name', None):
setup_logging()
def get_db_password(db_name):
from webnotes import defs
if hasattr(defs, 'get_db_password'):
return defs.get_db_password(db_name)
elif hasattr(defs, 'db_password'):
return defs.db_password
else:
return db_name