anoopmb
/
frappe
1
0
Forkuj 0
Kod Zgłoszenia 0 Oczekujące zmiany 0 Wydania 0 Wiki Aktywność
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
259 Commity
1 Gałąź
314 MiB
 
 
 
 
 
 
Drzewo: 37009b6e7d
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z '37009b6e7d'
${ noResults }
frappe/docs/_build/html/_modules/webnotes.html

325 wiersze
28 KiB
Czysty Wina Historia 

  1. 

  2. 

  3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  4.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  5. 

  6. <html xmlns="http://www.w3.org/1999/xhtml">

  7.   <head>

  8.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  9.     

  10.     <title>webnotes &mdash; WNFramework v1.8 documentation</title>

  11.     <link rel="stylesheet" href="../_static/default.css" type="text/css" />

  12.     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

  13.     <script type="text/javascript">

  14.       var DOCUMENTATION_OPTIONS = {

  15.         URL_ROOT:    '../',

  16.         VERSION:     '1.8',

  17.         COLLAPSE_INDEX: false,

  18.         FILE_SUFFIX: '.html',

  19.         HAS_SOURCE:  true

  20.       };

  21.     </script>

  22.     <script type="text/javascript" src="../_static/jquery.js"></script>

  23.     <script type="text/javascript" src="../_static/underscore.js"></script>

  24.     <script type="text/javascript" src="../_static/doctools.js"></script>

  25.     <link rel="top" title="WNFramework v1.8 documentation" href="../index.html" />

  26.     <link rel="up" title="Module code" href="index.html" /> 

  27.   </head>

  28.   <body>

  29.     <div class="related">

  30.       <h3>Navigation</h3>

  31.       <ul>

  32.         <li class="right" style="margin-right: 10px">

  33.           <a href="../genindex.html" title="General Index"

  34.              accesskey="I">index</a></li>

  35.         <li class="right" >

  36.           <a href="../py-modindex.html" title="Python Module Index"

  37.              >modules</a> |</li>

  38.         <li><a href="../index.html">WNFramework v1.8 documentation</a> &raquo;</li>

  39.           <li><a href="index.html" accesskey="U">Module code</a> &raquo;</li> 

  40.       </ul>

  41.     </div>  

  42. 

  43.     <div class="document">

  44.       <div class="documentwrapper">

  45.         <div class="bodywrapper">

  46.           <div class="body">

  47.             

  48.   <h1>Source code for webnotes</h1><div class="highlight"><pre>

  49. <span class="c">#</span>

  50. <span class="c"># import modules path</span>

  51. <span class="c"># </span>

  52. <span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">sys</span>

  53. 

  54. <span class="k">try</span><span class="p">:</span>

  55. 	<span class="kn">import</span> <span class="nn">webnotes.defs</span>

  56. 	<span class="n">m</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">defs</span><span class="p">,</span><span class="s">&#39;modules_path&#39;</span><span class="p">,</span><span class="bp">None</span><span class="p">)</span>

  57. 	<span class="n">m</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span>

  58. <span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span><span class="n">e</span><span class="p">:</span>

  59. 	<span class="k">raise</span> <span class="n">e</span>

  60. 

  61. <span class="c">#</span>

  62. <span class="c"># map for identifying which field values come from files</span>

  63. <span class="c">#</span>

  64. <span class="n">code_fields_dict</span> <span class="o">=</span> <span class="p">{</span>

  65. 	<span class="s">&#39;Page&#39;</span><span class="p">:[(</span><span class="s">&#39;script&#39;</span><span class="p">,</span> <span class="s">&#39;js&#39;</span><span class="p">),</span> <span class="p">(</span><span class="s">&#39;content&#39;</span><span class="p">,</span> <span class="s">&#39;html&#39;</span><span class="p">),</span> <span class="p">(</span><span class="s">&#39;style&#39;</span><span class="p">,</span> <span class="s">&#39;css&#39;</span><span class="p">),</span> <span class="p">(</span><span class="s">&#39;static_content&#39;</span><span class="p">,</span> <span class="s">&#39;html&#39;</span><span class="p">),</span> <span class="p">(</span><span class="s">&#39;server_code&#39;</span><span class="p">,</span> <span class="s">&#39;py&#39;</span><span class="p">)],</span>

  66. 	<span class="s">&#39;DocType&#39;</span><span class="p">:[(</span><span class="s">&#39;server_code_core&#39;</span><span class="p">,</span> <span class="s">&#39;py&#39;</span><span class="p">),</span> <span class="p">(</span><span class="s">&#39;client_script_core&#39;</span><span class="p">,</span> <span class="s">&#39;js&#39;</span><span class="p">)],</span>

  67. 	<span class="s">&#39;Search Criteria&#39;</span><span class="p">:[(</span><span class="s">&#39;report_script&#39;</span><span class="p">,</span> <span class="s">&#39;js&#39;</span><span class="p">),</span> <span class="p">(</span><span class="s">&#39;server_script&#39;</span><span class="p">,</span> <span class="s">&#39;py&#39;</span><span class="p">),</span> <span class="p">(</span><span class="s">&#39;custom_query&#39;</span><span class="p">,</span> <span class="s">&#39;sql&#39;</span><span class="p">)],</span>

  68. 	<span class="s">&#39;Patch&#39;</span><span class="p">:[(</span><span class="s">&#39;patch_code&#39;</span><span class="p">,</span> <span class="s">&#39;py&#39;</span><span class="p">)],</span>

  69. 	<span class="s">&#39;Stylesheet&#39;</span><span class="p">:[</span><span class="s">&#39;stylesheet&#39;</span><span class="p">,</span> <span class="s">&#39;css&#39;</span><span class="p">],</span>

  70. 	<span class="s">&#39;Page Template&#39;</span><span class="p">:[</span><span class="s">&#39;template&#39;</span><span class="p">,</span> <span class="s">&#39;html&#39;</span><span class="p">],</span>

  71. 	<span class="s">&#39;Control Panel&#39;</span><span class="p">:[(</span><span class="s">&#39;startup_code&#39;</span><span class="p">,</span> <span class="s">&#39;js&#39;</span><span class="p">),</span> <span class="p">(</span><span class="s">&#39;startup_css&#39;</span><span class="p">,</span> <span class="s">&#39;css&#39;</span><span class="p">)]</span>

  72. <span class="p">}</span>

  73. 

  74. <span class="c">#</span>

  75. <span class="c"># globals</span>

  76. <span class="c">#</span>

  77. <span class="c">#: &quot;v170&quot; </span>

  78. <span class="n">version</span> <span class="o">=</span> <span class="s">&#39;v170&#39;</span>

  79. <span class="n">form_dict</span> <span class="o">=</span> <span class="p">{}</span>

  80. <span class="n">auth_obj</span> <span class="o">=</span> <span class="bp">None</span>

  81. 

  82. <span class="c">#: The database connection :class:`webnotes.db.Database` setup by :mod:`auth`</span>

  83. <span class="n">conn</span> <span class="o">=</span> <span class="bp">None</span>

  84. 

  85. <span class="c">#: The cgi.FieldStorage() object (Dictionary representing the formdata from the URL)</span>

  86. <span class="n">form</span> <span class="o">=</span> <span class="bp">None</span>

  87. 

  88. <span class="n">session</span> <span class="o">=</span> <span class="bp">None</span>

  89. <span class="sd">&quot;&quot;&quot;</span>

  90. <span class="sd">   Global session dictionary.</span>

  91. 

  92. <span class="sd">   * session[&#39;user&#39;] - Current user   </span>

  93. <span class="sd">   * session[&#39;data&#39;] - Returns a dictionary of the session cache</span>

  94. <span class="sd">&quot;&quot;&quot;</span>

  95. 

  96. <span class="n">user</span> <span class="o">=</span> <span class="bp">None</span>

  97. <span class="n">is_testing</span> <span class="o">=</span> <span class="bp">None</span>

  98. <span class="sd">&quot;&quot;&quot;    Flag to identify if system is in :term:`Testing Mode` &quot;&quot;&quot;</span>

  99. 

  100. <span class="n">incoming_cookies</span> <span class="o">=</span> <span class="p">{}</span>

  101. <span class="n">add_cookies</span> <span class="o">=</span> <span class="p">{}</span>

  102. <span class="sd">&quot;&quot;&quot;    Dictionary of additional cookies appended by custom code &quot;&quot;&quot;</span>

  103. 

  104. <span class="n">cookies</span> <span class="o">=</span> <span class="p">{}</span>

  105. <span class="n">auto_masters</span> <span class="o">=</span> <span class="p">{}</span>

  106. <span class="n">tenant_id</span> <span class="o">=</span> <span class="bp">None</span>

  107. 

  108. <span class="c">#</span>

  109. <span class="c"># Custom Class (no traceback)</span>

  110. <span class="c">#</span>

  111. <div class="viewcode-block" id="ValidationError"><a class="viewcode-back" href="../webnotes.html#webnotes.ValidationError">[docs]</a><span class="k">class</span> <span class="nc">ValidationError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>

  112. 	<span class="k">pass</span>

  113. 

  114. <span class="c">#</span>

  115. <span class="c"># HTTP standard response</span>

  116. <span class="c">#</span></div>

  117. <span class="n">response</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;message&#39;</span><span class="p">:</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="s">&#39;exc&#39;</span><span class="p">:</span><span class="s">&#39;&#39;</span><span class="p">}</span>

  118. <span class="sd">&quot;&quot;&quot;</span>

  119. <span class="sd">   The JSON response object. Default is::</span>

  120. <span class="sd">   </span>

  121. <span class="sd">   {&#39;message&#39;:&#39;&#39;, &#39;exc&#39;:&#39;&#39;}</span>

  122. <span class="sd">&quot;&quot;&quot;</span>

  123. 

  124. <span class="c">#</span>

  125. <span class="c"># the logs</span>

  126. <span class="c">#</span>

  127. <span class="n">debug_log</span> <span class="o">=</span> <span class="p">[]</span>

  128. <span class="sd">&quot;&quot;&quot;    List of exceptions to be shown in the :term:`Error Console` &quot;&quot;&quot;</span>

  129. 

  130. <span class="n">message_log</span> <span class="o">=</span> <span class="p">[]</span>

  131. <span class="sd">&quot;&quot;&quot;    List of messages to be shown to the user in a popup box at the end of the request &quot;&quot;&quot;</span>

  132. 

  133. <div class="viewcode-block" id="getTraceback"><a class="viewcode-back" href="../webnotes.html#webnotes.getTraceback">[docs]</a><span class="k">def</span> <span class="nf">getTraceback</span><span class="p">():</span>

  134. 	<span class="kn">import</span> <span class="nn">webnotes.utils</span>

  135. 	<span class="k">return</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">getTraceback</span><span class="p">()</span>

  136. </div>

  137. <div class="viewcode-block" id="errprint"><a class="viewcode-back" href="../webnotes.html#webnotes.errprint">[docs]</a><span class="k">def</span> <span class="nf">errprint</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>

  138. 	<span class="sd">&quot;&quot;&quot;</span>

  139. <span class="sd">	   Append to the :data:`debug log`</span>

  140. <span class="sd">	&quot;&quot;&quot;</span>

  141. 	<span class="n">debug_log</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">msg</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span><span class="p">))</span>

  142. </div>

  143. <div class="viewcode-block" id="msgprint"><a class="viewcode-back" href="../webnotes.html#webnotes.msgprint">[docs]</a><span class="k">def</span> <span class="nf">msgprint</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">small</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">raise_exception</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>

  144. 	<span class="sd">&quot;&quot;&quot;</span>

  145. <span class="sd">	   Append to the :data:`message_log`</span>

  146. <span class="sd">	&quot;&quot;&quot;</span>	

  147. 	<span class="n">message_log</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">small</span> <span class="ow">and</span> <span class="s">&#39;__small:&#39;</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span><span class="p">)</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">msg</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span><span class="p">))</span>

  148. 	<span class="k">if</span> <span class="n">raise_exception</span><span class="p">:</span>

  149. 		<span class="k">raise</span> <span class="n">ValidationError</span>

  150. </div>

  151. <div class="viewcode-block" id="is_apache_user"><a class="viewcode-back" href="../webnotes.html#webnotes.is_apache_user">[docs]</a><span class="k">def</span> <span class="nf">is_apache_user</span><span class="p">():</span>

  152. 	<span class="kn">import</span> <span class="nn">os</span>

  153. 	<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;USER&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="s">&#39;apache&#39;</span><span class="p">:</span>

  154. 		<span class="k">return</span> <span class="bp">True</span> 

  155. 	<span class="k">else</span><span class="p">:</span>

  156. 		<span class="k">return</span> <span class="p">(</span><span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;USER&#39;</span><span class="p">))</span>

  157. 		<span class="c"># os.environ does not have user, so allows a security vulnerability,fixed now. </span>

  158. </div>

  159. <div class="viewcode-block" id="get_index_path"><a class="viewcode-back" href="../webnotes.html#webnotes.get_index_path">[docs]</a><span class="k">def</span> <span class="nf">get_index_path</span><span class="p">():</span>

  160. 	<span class="kn">import</span> <span class="nn">os</span>

  161. 	<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">__file__</span><span class="p">))</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">sep</span><span class="p">)[:</span><span class="o">-</span><span class="mi">2</span><span class="p">])</span>

  162. </div>

  163. <div class="viewcode-block" id="get_files_path"><a class="viewcode-back" href="../webnotes.html#webnotes.get_files_path">[docs]</a><span class="k">def</span> <span class="nf">get_files_path</span><span class="p">():</span>

  164. 	<span class="k">global</span> <span class="n">conn</span>

  165. 	<span class="kn">import</span> <span class="nn">defs</span><span class="o">,</span> <span class="nn">os</span>

  166. 

  167. 	<span class="k">if</span> <span class="ow">not</span> <span class="n">conn</span><span class="p">:</span>

  168. 		<span class="k">raise</span> <span class="ne">Exception</span><span class="p">,</span> <span class="s">&#39;You must login first&#39;</span>

  169. 

  170. 	<span class="k">if</span> <span class="n">defs</span><span class="o">.</span><span class="n">files_path</span><span class="p">:</span>

  171. 		<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">defs</span><span class="o">.</span><span class="n">files_path</span><span class="p">,</span> <span class="n">conn</span><span class="o">.</span><span class="n">cur_db_name</span><span class="p">)</span>

  172. 	<span class="k">else</span><span class="p">:</span>

  173. 		<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">get_index_path</span><span class="p">(),</span> <span class="s">&#39;user_files&#39;</span><span class="p">,</span> <span class="n">conn</span><span class="o">.</span><span class="n">cur_db_name</span><span class="p">)</span>

  174. 	</div>

  175. <div class="viewcode-block" id="create_folder"><a class="viewcode-back" href="../webnotes.html#webnotes.create_folder">[docs]</a><span class="k">def</span> <span class="nf">create_folder</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>

  176. 	<span class="sd">&quot;&quot;&quot;</span>

  177. <span class="sd">	Wrapper function for os.makedirs (does not throw exception if directory exists)</span>

  178. <span class="sd">	&quot;&quot;&quot;</span>

  179. 	<span class="kn">import</span> <span class="nn">os</span>

  180. 	

  181. 	<span class="k">try</span><span class="p">:</span>

  182. 		<span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>

  183. 	<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>

  184. 		<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">==</span><span class="mi">17</span><span class="p">:</span> 

  185. 			<span class="k">pass</span>

  186. 		<span class="k">else</span><span class="p">:</span> 

  187. 			<span class="k">raise</span> <span class="n">e</span>

  188. 

  189. 

  190. <span class="c">###############################################################################</span>

  191. <span class="c">#	BEGIN: TENTATIVE CODE FEELS LIKE A CLASS/TEMPLATE IS A BETTER IDEA FOR THESE VARIABLES.</span>

  192. <span class="c">#	Bad idea combining/using one function to set conn,user,session variables.</span>

  193. <span class="c">#	Need to split up.</span>

  194. <span class="c">###############################################################################</span>

  195. </div>

  196. <div class="viewcode-block" id="set_as_account_master"><a class="viewcode-back" href="../webnotes.html#webnotes.set_as_account_master">[docs]</a><span class="k">def</span> <span class="nf">set_as_account_master</span><span class="p">():</span>

  197. 	<span class="kn">import</span> <span class="nn">webnotes.db</span>

  198. 	<span class="k">global</span> <span class="n">conn</span>

  199. 	<span class="n">conn</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">Database</span><span class="p">(</span><span class="n">use_default</span> <span class="o">=</span> <span class="mi">1</span><span class="p">)</span>

  200. </div>

  201. <div class="viewcode-block" id="set_as_administrator"><a class="viewcode-back" href="../webnotes.html#webnotes.set_as_administrator">[docs]</a><span class="k">def</span> <span class="nf">set_as_administrator</span><span class="p">():</span>

  202. 	

  203. 	<span class="k">global</span> <span class="n">user</span>

  204. 	

  205. 	<span class="k">if</span> <span class="n">is_apache_user</span><span class="p">():</span>

  206. 		<span class="k">raise</span> <span class="ne">Exception</span><span class="p">,</span> <span class="s">&#39;Not for web users!&#39;</span>

  207. 

  208. 	<span class="kn">import</span> <span class="nn">webnotes.profile</span>

  209. 	<span class="n">user</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">profile</span><span class="o">.</span><span class="n">Profile</span><span class="p">(</span><span class="s">&#39;Administrator&#39;</span><span class="p">)</span>

  210. </div>

  211. <div class="viewcode-block" id="set_as_admin_session"><a class="viewcode-back" href="../webnotes.html#webnotes.set_as_admin_session">[docs]</a><span class="k">def</span> <span class="nf">set_as_admin_session</span><span class="p">():</span>

  212. 	<span class="k">global</span> <span class="n">session</span>

  213. 	<span class="n">session</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;user&#39;</span><span class="p">:</span><span class="s">&#39;Administrator&#39;</span><span class="p">}</span>

  214. 

  215. <span class="c">###############################################################################</span>

  216. <span class="c">#END  </span>

  217. <span class="c">###############################################################################</span>

  218. 

  219. </div>

  220. <div class="viewcode-block" id="set_as_admin"><a class="viewcode-back" href="../webnotes.html#webnotes.set_as_admin">[docs]</a><span class="k">def</span> <span class="nf">set_as_admin</span><span class="p">(</span><span class="n">db_name</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">ac_name</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>

  221. 

  222. 	<span class="kn">import</span> <span class="nn">os</span>

  223. 	<span class="k">if</span> <span class="n">is_apache_user</span><span class="p">():</span>

  224. 		<span class="k">raise</span> <span class="ne">Exception</span><span class="p">,</span> <span class="s">&#39;Not for web users!&#39;</span>

  225. 

  226. 	<span class="k">global</span> <span class="n">conn</span>

  227. 	<span class="k">global</span> <span class="n">session</span>

  228. 	<span class="k">global</span> <span class="n">user</span>

  229. 	

  230. 	<span class="kn">import</span> <span class="nn">webnotes.db</span>

  231. 	<span class="k">if</span> <span class="n">ac_name</span><span class="p">:</span>

  232. 		<span class="n">conn</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">Database</span><span class="p">(</span><span class="n">ac_name</span> <span class="o">=</span> <span class="n">ac_name</span><span class="p">)</span>

  233. 	<span class="k">else</span><span class="p">:</span>

  234. 		<span class="n">set_as_account_master</span><span class="p">()</span>

  235. 		<span class="k">if</span> <span class="n">db_name</span><span class="p">:</span>

  236. 			<span class="n">conn</span><span class="o">.</span><span class="n">use</span><span class="p">(</span><span class="n">db_name</span><span class="p">)</span>

  237. 		

  238. 	<span class="n">session</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;user&#39;</span><span class="p">:</span><span class="s">&#39;Administrator&#39;</span><span class="p">}</span>

  239. 	<span class="kn">import</span> <span class="nn">webnotes.profile</span>

  240. 	<span class="n">user</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">profile</span><span class="o">.</span><span class="n">Profile</span><span class="p">(</span><span class="s">&#39;Administrator&#39;</span><span class="p">)</span>

  241. 

  242. 

  243. <span class="c"># Environment Variables</span>

  244. <span class="c">#-----------------------------------------------------------</span></div>

  245. <div class="viewcode-block" id="get_env_vars"><a class="viewcode-back" href="../webnotes.html#webnotes.get_env_vars">[docs]</a><span class="k">def</span> <span class="nf">get_env_vars</span><span class="p">(</span><span class="n">env_var</span><span class="p">):</span>

  246. 	<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">env_var</span><span class="p">,</span><span class="s">&#39;None&#39;</span><span class="p">)</span>

  247. </div>

  248. <span class="n">remote_ip</span> <span class="o">=</span> <span class="n">get_env_vars</span><span class="p">(</span><span class="s">&#39;REMOTE_ADDR&#39;</span><span class="p">)</span>		<span class="c">#Required for login from python shell</span>

  249. 

  250. <span class="c"># Logging</span>

  251. <span class="c"># -----------------------------------------------------------</span>

  252. 

  253. <span class="n">logger</span> <span class="o">=</span> <span class="bp">None</span>

  254. 

  255. 

  256. <div class="viewcode-block" id="setup_logging"><a class="viewcode-back" href="../webnotes.html#webnotes.setup_logging">[docs]</a><span class="k">def</span> <span class="nf">setup_logging</span><span class="p">():</span>

  257. 	<span class="kn">import</span> <span class="nn">logging</span>

  258. 	<span class="kn">import</span> <span class="nn">logging.handlers</span>

  259. 	<span class="c"># Also please set umask for apache to 002.</span>

  260. 	<span class="k">global</span> <span class="n">logger</span>

  261. 

  262. 	<span class="k">try</span><span class="p">:</span>

  263. 		<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s">&#39;WNLogger&#39;</span><span class="p">)</span>

  264. 		<span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="nb">eval</span><span class="p">(</span><span class="n">defs</span><span class="o">.</span><span class="n">log_level</span><span class="p">))</span>

  265. 

  266. 		<span class="n">log_handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">handlers</span><span class="o">.</span><span class="n">RotatingFileHandler</span><span class="p">(</span><span class="n">defs</span><span class="o">.</span><span class="n">log_file_name</span><span class="p">,</span> <span class="n">maxBytes</span> <span class="o">=</span> <span class="n">defs</span><span class="o">.</span><span class="n">log_file_size</span><span class="p">,</span> <span class="n">backupCount</span> <span class="o">=</span> <span class="n">defs</span><span class="o">.</span><span class="n">log_file_backup_count</span><span class="p">)</span>	

  267. 		<span class="n">formatter</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span><span class="s">&#39;</span><span class="si">%(name)s</span><span class="s"> - </span><span class="si">%(asctime)s</span><span class="s"> - </span><span class="si">%(levelname)s</span><span class="se">\n</span><span class="si">%(message)s</span><span class="se">\n</span><span class="s">-------------------&#39;</span><span class="p">)</span>

  268. 	

  269. 		<span class="n">log_handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">formatter</span><span class="p">)</span>

  270. 		<span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">log_handler</span><span class="p">)</span>

  271. 	

  272. 	<span class="k">except</span> <span class="ne">IOError</span><span class="p">,</span><span class="n">e</span><span class="p">:</span>

  273. 		<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span> <span class="o">==</span> <span class="mi">13</span><span class="p">:</span>

  274. 			<span class="nb">open</span><span class="p">(</span><span class="n">defs</span><span class="o">.</span><span class="n">log_file_name</span><span class="p">)</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  275. 

  276. </div>

  277. <span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">defs</span><span class="p">,</span> <span class="s">&#39;log_file_name&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">):</span>

  278. 	<span class="n">setup_logging</span><span class="p">()</span>

  279. 	

  280. </pre></div>

  281. 

  282.           </div>

  283.         </div>

  284.       </div>

  285.       <div class="sphinxsidebar">

  286.         <div class="sphinxsidebarwrapper">

  287.             <p class="logo"><a href="../index.html">

  288.               <img class="logo" src="../_static/wnflogo200.gif" alt="Logo"/>

  289.             </a></p>

  290. <div id="searchbox" style="display: none">

  291.   <h3>Quick search</h3>

  292.     <form class="search" action="../search.html" method="get">

  293.       <input type="text" name="q" size="18" />

  294.       <input type="submit" value="Go" />

  295.       <input type="hidden" name="check_keywords" value="yes" />

  296.       <input type="hidden" name="area" value="default" />

  297.     </form>

  298.     <p class="searchtip" style="font-size: 90%">

  299.     Enter search terms or a module, class or function name.

  300.     </p>

  301. </div>

  302. <script type="text/javascript">$('#searchbox').show(0);</script>

  303.         </div>

  304.       </div>

  305.       <div class="clearer"></div>

  306.     </div>

  307.     <div class="related">

  308.       <h3>Navigation</h3>

  309.       <ul>

  310.         <li class="right" style="margin-right: 10px">

  311.           <a href="../genindex.html" title="General Index"

  312.              >index</a></li>

  313.         <li class="right" >

  314.           <a href="../py-modindex.html" title="Python Module Index"

  315.              >modules</a> |</li>

  316.         <li><a href="../index.html">WNFramework v1.8 documentation</a> &raquo;</li>

  317.           <li><a href="index.html" >Module code</a> &raquo;</li> 

  318.       </ul>

  319.     </div>

  320.     <div class="footer">

  321.         &copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.

  322.       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.

  323.     </div>

  324.   </body>

  325. </html>