Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
 
 
 
 
 
 

520 строки
66 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>webnotes.auth &mdash; WNFramework v1.8 documentation</title>
  7. <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
  8. <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../../',
  12. VERSION: '1.8',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../../_static/jquery.js"></script>
  19. <script type="text/javascript" src="../../_static/underscore.js"></script>
  20. <script type="text/javascript" src="../../_static/doctools.js"></script>
  21. <link rel="top" title="WNFramework v1.8 documentation" href="../../index.html" />
  22. <link rel="up" title="webnotes" href="../webnotes.html" />
  23. </head>
  24. <body>
  25. <div class="related">
  26. <h3>Navigation</h3>
  27. <ul>
  28. <li class="right" style="margin-right: 10px">
  29. <a href="../../genindex.html" title="General Index"
  30. accesskey="I">index</a></li>
  31. <li class="right" >
  32. <a href="../../py-modindex.html" title="Python Module Index"
  33. >modules</a> |</li>
  34. <li><a href="../../index.html">WNFramework v1.8 documentation</a> &raquo;</li>
  35. <li><a href="../index.html" >Module code</a> &raquo;</li>
  36. <li><a href="../webnotes.html" accesskey="U">webnotes</a> &raquo;</li>
  37. </ul>
  38. </div>
  39. <div class="document">
  40. <div class="documentwrapper">
  41. <div class="bodywrapper">
  42. <div class="body">
  43. <h1>Source code for webnotes.auth</h1><div class="highlight"><pre>
  44. <span class="kn">import</span> <span class="nn">webnotes</span>
  45. <span class="kn">import</span> <span class="nn">webnotes.db</span>
  46. <span class="kn">import</span> <span class="nn">webnotes.utils</span>
  47. <span class="kn">import</span> <span class="nn">webnotes.profile</span>
  48. <span class="kn">import</span> <span class="nn">webnotes.defs</span>
  49. <span class="c"># =================================================================================</span>
  50. <span class="c"># HTTPRequest</span>
  51. <span class="c"># =================================================================================</span>
  52. <div class="viewcode-block" id="HTTPRequest"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.HTTPRequest">[docs]</a><span class="k">class</span> <span class="nc">HTTPRequest</span><span class="p">:</span>
  53. <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  54. <span class="c"># Get Environment variables</span>
  55. <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">get_env_vars</span><span class="p">(</span><span class="s">&#39;HTTP_HOST&#39;</span><span class="p">)</span>
  56. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">&#39;www.&#39;</span><span class="p">):</span>
  57. <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="p">[</span><span class="mi">4</span><span class="p">:]</span>
  58. <span class="n">webnotes</span><span class="o">.</span><span class="n">remote_ip</span> <span class="o">=</span> <span class="n">webnotes</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>
  59. <span class="c"># load cookies</span>
  60. <span class="n">webnotes</span><span class="o">.</span><span class="n">cookie_manager</span> <span class="o">=</span> <span class="n">CookieManager</span><span class="p">()</span>
  61. <span class="c"># set db</span>
  62. <span class="bp">self</span><span class="o">.</span><span class="n">set_db</span><span class="p">()</span>
  63. <span class="c"># check status</span>
  64. <span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">get_global</span><span class="p">(</span><span class="s">&quot;__session_status&quot;</span><span class="p">)</span><span class="o">==</span><span class="s">&#39;stop&#39;</span><span class="p">:</span>
  65. <span class="n">webnotes</span><span class="o">.</span><span class="n">msgprint</span><span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">get_global</span><span class="p">(</span><span class="s">&quot;__session_status_message&quot;</span><span class="p">))</span>
  66. <span class="k">raise</span> <span class="ne">Exception</span>
  67. <span class="c"># -----------------------------</span>
  68. <span class="c"># start transaction</span>
  69. <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span>
  70. <span class="c"># login</span>
  71. <span class="n">webnotes</span><span class="o">.</span><span class="n">login_manager</span> <span class="o">=</span> <span class="n">LoginManager</span><span class="p">()</span>
  72. <span class="c"># start session</span>
  73. <span class="n">webnotes</span><span class="o">.</span><span class="n">session_obj</span> <span class="o">=</span> <span class="n">Session</span><span class="p">()</span>
  74. <span class="n">webnotes</span><span class="o">.</span><span class="n">session</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">session_obj</span><span class="o">.</span><span class="n">data</span>
  75. <span class="n">webnotes</span><span class="o">.</span><span class="n">tenant_id</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;tenant_id&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
  76. <span class="c"># write out cookies if sid is supplied (this is a pre-logged in redirect)</span>
  77. <span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;sid&#39;</span><span class="p">):</span>
  78. <span class="n">webnotes</span><span class="o">.</span><span class="n">cookie_manager</span><span class="o">.</span><span class="n">set_cookies</span><span class="p">()</span>
  79. <span class="c"># run login triggers</span>
  80. <span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;cmd&#39;</span><span class="p">)</span><span class="o">==</span><span class="s">&#39;login&#39;</span><span class="p">:</span>
  81. <span class="n">webnotes</span><span class="o">.</span><span class="n">login_manager</span><span class="o">.</span><span class="n">run_trigger</span><span class="p">(</span><span class="s">&#39;on_login_post_session&#39;</span><span class="p">)</span>
  82. <span class="c"># load profile</span>
  83. <span class="bp">self</span><span class="o">.</span><span class="n">setup_profile</span><span class="p">()</span>
  84. <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
  85. <span class="c"># end transaction</span>
  86. <span class="c"># -----------------------------</span>
  87. <span class="c"># setup profile</span>
  88. <span class="c"># -------------</span>
  89. <div class="viewcode-block" id="HTTPRequest.setup_profile"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.HTTPRequest.setup_profile">[docs]</a> <span class="k">def</span> <span class="nf">setup_profile</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  90. <span class="n">webnotes</span><span class="o">.</span><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>
  91. <span class="c"># load the profile data</span>
  92. <span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">session</span><span class="p">[</span><span class="s">&#39;data&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;profile&#39;</span><span class="p">):</span>
  93. <span class="n">webnotes</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">load_from_session</span><span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">session</span><span class="p">[</span><span class="s">&#39;data&#39;</span><span class="p">][</span><span class="s">&#39;profile&#39;</span><span class="p">])</span>
  94. <span class="k">else</span><span class="p">:</span>
  95. <span class="n">webnotes</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">load_profile</span><span class="p">()</span>
  96. <span class="c"># get account name</span>
  97. <span class="c"># ------------------</span>
  98. </div>
  99. <div class="viewcode-block" id="HTTPRequest.get_ac_name"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.HTTPRequest.get_ac_name">[docs]</a> <span class="k">def</span> <span class="nf">get_ac_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  100. <span class="c"># login</span>
  101. <span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;acx&#39;</span><span class="p">):</span>
  102. <span class="k">return</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;acx&#39;</span><span class="p">)</span>
  103. <span class="c"># in form</span>
  104. <span class="k">elif</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;ac_name&#39;</span><span class="p">):</span>
  105. <span class="k">return</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;ac_name&#39;</span><span class="p">)</span>
  106. <span class="c"># in cookie</span>
  107. <span class="k">elif</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">incoming_cookies</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;ac_name&#39;</span><span class="p">):</span>
  108. <span class="k">return</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">incoming_cookies</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;ac_name&#39;</span><span class="p">)</span>
  109. <span class="c"># set database login</span>
  110. <span class="c"># ------------------</span>
  111. </div>
  112. <div class="viewcode-block" id="HTTPRequest.set_db"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.HTTPRequest.set_db">[docs]</a> <span class="k">def</span> <span class="nf">set_db</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ac_name</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
  113. <span class="c"># select based on subdomain</span>
  114. <span class="k">if</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;domain_name_map&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="p">):</span>
  115. <span class="n">db_name</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">defs</span><span class="o">.</span><span class="n">domain_name_map</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="p">]</span>
  116. <span class="c"># select based on ac_name</span>
  117. <span class="k">else</span><span class="p">:</span>
  118. <span class="n">ac_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_ac_name</span><span class="p">()</span>
  119. <span class="k">if</span> <span class="n">ac_name</span><span class="p">:</span>
  120. <span class="n">db_name</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;db_name_map&#39;</span><span class="p">,{})</span><span class="o">.</span>\
  121. <span class="n">get</span><span class="p">(</span><span class="n">ac_name</span><span class="p">,</span> <span class="n">ac_name</span><span class="p">)</span>
  122. <span class="k">else</span><span class="p">:</span>
  123. <span class="n">db_name</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;default_db_name&#39;</span><span class="p">,</span><span class="s">&#39;&#39;</span><span class="p">)</span>
  124. <span class="n">webnotes</span><span class="o">.</span><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">user</span> <span class="o">=</span> <span class="n">db_name</span><span class="p">,</span><span class="n">password</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;db_password&#39;</span><span class="p">,</span><span class="s">&#39;&#39;</span><span class="p">))</span>
  125. <span class="n">webnotes</span><span class="o">.</span><span class="n">ac_name</span> <span class="o">=</span> <span class="n">ac_name</span>
  126. <span class="c"># =================================================================================</span>
  127. <span class="c"># Login Manager</span>
  128. <span class="c"># =================================================================================</span>
  129. </div></div>
  130. <div class="viewcode-block" id="LoginManager"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.LoginManager">[docs]</a><span class="k">class</span> <span class="nc">LoginManager</span><span class="p">:</span>
  131. <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  132. <span class="bp">self</span><span class="o">.</span><span class="n">cp</span> <span class="o">=</span> <span class="bp">None</span>
  133. <span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;cmd&#39;</span><span class="p">)</span><span class="o">==</span><span class="s">&#39;login&#39;</span><span class="p">:</span>
  134. <span class="c"># clear cache</span>
  135. <span class="kn">from</span> <span class="nn">webnotes.session_cache</span> <span class="kn">import</span> <span class="n">clear_cache</span>
  136. <span class="n">clear_cache</span><span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;usr&#39;</span><span class="p">))</span>
  137. <span class="bp">self</span><span class="o">.</span><span class="n">authenticate</span><span class="p">()</span>
  138. <span class="bp">self</span><span class="o">.</span><span class="n">post_login</span><span class="p">()</span>
  139. <span class="n">webnotes</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s">&#39;message&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;Logged In&#39;</span>
  140. <span class="c"># run triggers, write cookies</span>
  141. <span class="c"># ---------------------------</span>
  142. <div class="viewcode-block" id="LoginManager.post_login"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.LoginManager.post_login">[docs]</a> <span class="k">def</span> <span class="nf">post_login</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  143. <span class="bp">self</span><span class="o">.</span><span class="n">validate_ip_address</span><span class="p">()</span>
  144. <span class="bp">self</span><span class="o">.</span><span class="n">run_trigger</span><span class="p">()</span>
  145. <span class="c"># check password</span>
  146. <span class="c"># --------------</span>
  147. </div>
  148. <div class="viewcode-block" id="LoginManager.authenticate"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.LoginManager.authenticate">[docs]</a> <span class="k">def</span> <span class="nf">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">pwd</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
  149. <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">user</span> <span class="ow">and</span> <span class="n">pwd</span><span class="p">):</span>
  150. <span class="n">user</span><span class="p">,</span> <span class="n">pwd</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;usr&#39;</span><span class="p">),</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;pwd&#39;</span><span class="p">)</span>
  151. <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">user</span> <span class="ow">and</span> <span class="n">pwd</span><span class="p">):</span>
  152. <span class="n">webnotes</span><span class="o">.</span><span class="n">msgprint</span><span class="p">(</span><span class="s">&#39;Incomplete Login Details&#39;</span><span class="p">,</span> <span class="n">raise_exception</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
  153. <span class="c"># custom authentication (for single-sign on)</span>
  154. <span class="bp">self</span><span class="o">.</span><span class="n">load_control_panel</span><span class="p">()</span>
  155. <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cp</span><span class="p">,</span> <span class="s">&#39;authenticate&#39;</span><span class="p">):</span>
  156. <span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cp</span><span class="o">.</span><span class="n">authenticate</span><span class="p">()</span>
  157. <span class="c"># check the password</span>
  158. <span class="k">if</span> <span class="n">user</span><span class="o">==</span><span class="s">&#39;Administrator&#39;</span><span class="p">:</span>
  159. <span class="n">p</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;select name from tabProfile where name=</span><span class="si">%s</span><span class="s"> and (`password`=</span><span class="si">%s</span><span class="s"> OR `password`=PASSWORD(</span><span class="si">%s</span><span class="s">))&quot;</span><span class="p">,</span> <span class="p">(</span><span class="n">user</span><span class="p">,</span> <span class="n">pwd</span><span class="p">,</span> <span class="n">pwd</span><span class="p">))</span>
  160. <span class="k">else</span><span class="p">:</span>
  161. <span class="n">p</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;select name from tabProfile where name=</span><span class="si">%s</span><span class="s"> and (`password`=</span><span class="si">%s</span><span class="s"> OR `password`=PASSWORD(</span><span class="si">%s</span><span class="s">)) and IFNULL(enabled,0)=1&quot;</span><span class="p">,</span> <span class="p">(</span><span class="n">user</span><span class="p">,</span> <span class="n">pwd</span><span class="p">,</span> <span class="n">pwd</span><span class="p">))</span>
  162. <span class="k">if</span> <span class="ow">not</span> <span class="n">p</span><span class="p">:</span>
  163. <span class="n">webnotes</span><span class="o">.</span><span class="n">msgprint</span><span class="p">(</span><span class="s">&#39;Authentication Failed&#39;</span><span class="p">,</span> <span class="n">raise_exception</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
  164. <span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="n">p</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
  165. <span class="c"># triggers</span>
  166. <span class="c"># --------</span>
  167. </div>
  168. <div class="viewcode-block" id="LoginManager.load_control_panel"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.LoginManager.load_control_panel">[docs]</a> <span class="k">def</span> <span class="nf">load_control_panel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  169. <span class="kn">import</span> <span class="nn">webnotes.model.code</span>
  170. <span class="k">try</span><span class="p">:</span>
  171. <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cp</span><span class="p">:</span>
  172. <span class="bp">self</span><span class="o">.</span><span class="n">cp</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">code</span><span class="o">.</span><span class="n">get_obj</span><span class="p">(</span><span class="s">&#39;Control Panel&#39;</span><span class="p">)</span>
  173. <span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
  174. <span class="n">webnotes</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s">&#39;Control Panel Exception&#39;</span><span class="p">]</span> <span class="o">=</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>
  175. <span class="c"># --------</span></div>
  176. <div class="viewcode-block" id="LoginManager.run_trigger"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.LoginManager.run_trigger">[docs]</a> <span class="k">def</span> <span class="nf">run_trigger</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s">&#39;on_login&#39;</span><span class="p">):</span>
  177. <span class="k">try</span><span class="p">:</span>
  178. <span class="kn">import</span> <span class="nn">event_handlers</span>
  179. <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">event_handlers</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
  180. <span class="nb">getattr</span><span class="p">(</span><span class="n">event_handlers</span><span class="p">,</span> <span class="n">method</span><span class="p">)(</span><span class="bp">self</span><span class="p">)</span>
  181. <span class="k">return</span>
  182. <span class="k">except</span> <span class="ne">ImportError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
  183. <span class="k">pass</span>
  184. <span class="c"># deprecated</span>
  185. <span class="bp">self</span><span class="o">.</span><span class="n">load_control_panel</span><span class="p">()</span>
  186. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cp</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cp</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
  187. <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cp</span><span class="p">,</span> <span class="n">method</span><span class="p">)(</span><span class="bp">self</span><span class="p">)</span>
  188. <span class="c"># ip validation</span>
  189. <span class="c"># -------------</span>
  190. </div>
  191. <div class="viewcode-block" id="LoginManager.validate_ip_address"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.LoginManager.validate_ip_address">[docs]</a> <span class="k">def</span> <span class="nf">validate_ip_address</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  192. <span class="k">try</span><span class="p">:</span>
  193. <span class="n">ip</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;select ip_address from tabProfile where name = &#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">user</span><span class="p">)[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span>
  194. <span class="k">except</span><span class="p">:</span> <span class="k">return</span>
  195. <span class="n">ip</span> <span class="o">=</span> <span class="n">ip</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">,</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;</span><span class="se">\n</span><span class="s">&#39;</span><span class="p">)</span>
  196. <span class="n">ip</span> <span class="o">=</span> <span class="p">[</span><span class="n">i</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">ip</span><span class="p">]</span>
  197. <span class="k">if</span> <span class="n">ret</span> <span class="ow">and</span> <span class="n">ip</span><span class="p">:</span>
  198. <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">remote_ip</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">ip</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="ow">or</span> <span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">remote_ip</span> <span class="ow">in</span> <span class="n">ip</span><span class="p">)):</span>
  199. <span class="k">raise</span> <span class="ne">Exception</span><span class="p">,</span> <span class="s">&#39;Not allowed from this IP Address&#39;</span>
  200. <span class="c"># login as guest</span>
  201. <span class="c"># --------------</span>
  202. </div>
  203. <div class="viewcode-block" id="LoginManager.login_as_guest"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.LoginManager.login_as_guest">[docs]</a> <span class="k">def</span> <span class="nf">login_as_guest</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  204. <span class="n">res</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;select name from tabProfile where name=&#39;Guest&#39; and ifnull(enabled,0)=1&quot;</span><span class="p">)</span>
  205. <span class="k">if</span> <span class="ow">not</span> <span class="n">res</span><span class="p">:</span>
  206. <span class="k">raise</span> <span class="ne">Exception</span><span class="p">,</span> <span class="s">&quot;No Guest Access&quot;</span>
  207. <span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="s">&#39;Guest&#39;</span>
  208. <span class="bp">self</span><span class="o">.</span><span class="n">post_login</span><span class="p">()</span>
  209. <span class="c"># Logout</span>
  210. <span class="c"># ------</span>
  211. </div>
  212. <div class="viewcode-block" id="LoginManager.call_on_logout_event"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.LoginManager.call_on_logout_event">[docs]</a> <span class="k">def</span> <span class="nf">call_on_logout_event</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  213. <span class="kn">import</span> <span class="nn">webnotes.model.code</span>
  214. <span class="n">cp</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">code</span><span class="o">.</span><span class="n">get_obj</span><span class="p">(</span><span class="s">&#39;Control Panel&#39;</span><span class="p">,</span> <span class="s">&#39;Control Panel&#39;</span><span class="p">)</span>
  215. <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">cp</span><span class="p">,</span> <span class="s">&#39;on_logout&#39;</span><span class="p">):</span>
  216. <span class="n">cp</span><span class="o">.</span><span class="n">on_logout</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
  217. </div>
  218. <div class="viewcode-block" id="LoginManager.logout"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.LoginManager.logout">[docs]</a> <span class="k">def</span> <span class="nf">logout</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">arg</span><span class="o">=</span><span class="s">&#39;&#39;</span><span class="p">):</span>
  219. <span class="bp">self</span><span class="o">.</span><span class="n">run_trigger</span><span class="p">(</span><span class="s">&#39;on_logout&#39;</span><span class="p">)</span>
  220. <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&#39;update tabSessions set status=&quot;Logged Out&quot; where sid=&quot;</span><span class="si">%s</span><span class="s">&quot;&#39;</span> <span class="o">%</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">session</span><span class="p">[</span><span class="s">&#39;sid&#39;</span><span class="p">])</span>
  221. <span class="c"># =================================================================================</span>
  222. <span class="c"># Cookie Manager</span>
  223. <span class="c"># =================================================================================</span>
  224. </div></div>
  225. <div class="viewcode-block" id="CookieManager"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.CookieManager">[docs]</a><span class="k">class</span> <span class="nc">CookieManager</span><span class="p">:</span>
  226. <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  227. <span class="kn">import</span> <span class="nn">Cookie</span>
  228. <span class="n">webnotes</span><span class="o">.</span><span class="n">cookies</span> <span class="o">=</span> <span class="n">Cookie</span><span class="o">.</span><span class="n">SimpleCookie</span><span class="p">()</span>
  229. <span class="bp">self</span><span class="o">.</span><span class="n">get_incoming_cookies</span><span class="p">()</span>
  230. <span class="c"># get incoming cookies</span>
  231. <span class="c"># --------------------</span>
  232. <div class="viewcode-block" id="CookieManager.get_incoming_cookies"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.CookieManager.get_incoming_cookies">[docs]</a> <span class="k">def</span> <span class="nf">get_incoming_cookies</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  233. <span class="kn">import</span> <span class="nn">os</span>
  234. <span class="n">cookies</span> <span class="o">=</span> <span class="p">{}</span>
  235. <span class="k">if</span> <span class="s">&#39;HTTP_COOKIE&#39;</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
  236. <span class="n">c</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">&#39;HTTP_COOKIE&#39;</span><span class="p">]</span>
  237. <span class="n">webnotes</span><span class="o">.</span><span class="n">cookies</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
  238. <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">cookies</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
  239. <span class="n">cookies</span><span class="p">[</span><span class="n">c</span><span class="o">.</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">value</span>
  240. <span class="n">webnotes</span><span class="o">.</span><span class="n">incoming_cookies</span> <span class="o">=</span> <span class="n">cookies</span>
  241. <span class="c"># Set cookies</span>
  242. <span class="c"># -----------</span>
  243. </div>
  244. <div class="viewcode-block" id="CookieManager.set_cookies"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.CookieManager.set_cookies">[docs]</a> <span class="k">def</span> <span class="nf">set_cookies</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  245. <span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">cur_db_name</span><span class="p">:</span>
  246. <span class="n">webnotes</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="s">&#39;account_id&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">cur_db_name</span>
  247. <span class="c"># ac_name </span>
  248. <span class="n">webnotes</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="s">&#39;ac_name&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">ac_name</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span>
  249. <span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;sid&#39;</span><span class="p">):</span>
  250. <span class="n">webnotes</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="s">&#39;sid&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">session</span><span class="p">[</span><span class="s">&#39;sid&#39;</span><span class="p">]</span>
  251. <span class="c"># sid expires in 3 days</span>
  252. <span class="kn">import</span> <span class="nn">datetime</span>
  253. <span class="n">expires</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span> <span class="o">+</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
  254. <span class="n">webnotes</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="s">&#39;sid&#39;</span><span class="p">][</span><span class="s">&#39;expires&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">expires</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">&#39;%a, </span><span class="si">%d</span><span class="s"> %b %Y %H:%M:%S&#39;</span><span class="p">)</span>
  255. <span class="c"># Set Remember Me</span>
  256. <span class="c"># ---------------</span>
  257. </div>
  258. <div class="viewcode-block" id="CookieManager.set_remember_me"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.CookieManager.set_remember_me">[docs]</a> <span class="k">def</span> <span class="nf">set_remember_me</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  259. <span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">cint</span><span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;remember_me&#39;</span><span class="p">)):</span>
  260. <span class="n">remember_days</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s">&#39;Control Panel&#39;</span><span class="p">,</span><span class="bp">None</span><span class="p">,</span><span class="s">&#39;remember_for_days&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="mi">7</span>
  261. <span class="n">webnotes</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="s">&#39;remember_me&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
  262. <span class="kn">import</span> <span class="nn">datetime</span>
  263. <span class="n">expires</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span> <span class="o">+</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="n">remember_days</span><span class="p">)</span>
  264. <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">cookies</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
  265. <span class="n">webnotes</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="n">k</span><span class="p">][</span><span class="s">&#39;expires&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">expires</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">&#39;%a, </span><span class="si">%d</span><span class="s"> %b %Y %H:%M:%S&#39;</span><span class="p">)</span>
  266. <span class="c"># =================================================================================</span>
  267. <span class="c"># Session </span>
  268. <span class="c"># =================================================================================</span>
  269. </div></div>
  270. <div class="viewcode-block" id="Session"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.Session">[docs]</a><span class="k">class</span> <span class="nc">Session</span><span class="p">:</span>
  271. <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
  272. <span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="n">user</span>
  273. <span class="bp">self</span><span class="o">.</span><span class="n">sid</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;sid&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">incoming_cookies</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;sid&#39;</span><span class="p">)</span>
  274. <span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;user&#39;</span><span class="p">:</span><span class="n">user</span><span class="p">,</span><span class="s">&#39;data&#39;</span><span class="p">:{}}</span>
  275. <span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;cmd&#39;</span><span class="p">)</span><span class="o">==</span><span class="s">&#39;login&#39;</span><span class="p">:</span>
  276. <span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
  277. <span class="k">return</span>
  278. <span class="bp">self</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
  279. <span class="c"># start a session</span>
  280. <span class="c"># ---------------</span>
  281. <div class="viewcode-block" id="Session.load"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.Session.load">[docs]</a> <span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  282. <span class="kn">import</span> <span class="nn">webnotes</span>
  283. <span class="n">r</span><span class="o">=</span><span class="bp">None</span>
  284. <span class="k">try</span><span class="p">:</span>
  285. <span class="n">r</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;select user, sessiondata, status from tabSessions where sid=&#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">sid</span><span class="p">)</span>
  286. <span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
  287. <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">1054</span><span class="p">:</span>
  288. <span class="bp">self</span><span class="o">.</span><span class="n">add_status_column</span><span class="p">()</span>
  289. <span class="k">else</span><span class="p">:</span>
  290. <span class="k">raise</span> <span class="n">e</span>
  291. <span class="k">if</span> <span class="n">r</span><span class="p">:</span>
  292. <span class="n">r</span><span class="o">=</span><span class="n">r</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
  293. <span class="c"># ExipredSession</span>
  294. <span class="k">if</span> <span class="n">r</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="o">==</span><span class="s">&#39;Expired&#39;</span> <span class="ow">and</span> <span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;cmd&#39;</span><span class="p">)</span><span class="o">!=</span><span class="s">&#39;resume_session&#39;</span><span class="p">):</span>
  295. <span class="k">if</span> <span class="n">r</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">==</span><span class="s">&#39;Guest&#39;</span> <span class="ow">or</span> <span class="p">(</span><span class="ow">not</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;cmd&#39;</span><span class="p">))</span> <span class="ow">or</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;cmd&#39;</span><span class="p">)</span><span class="o">==</span><span class="s">&#39;logout&#39;</span><span class="p">:</span>
  296. <span class="n">webnotes</span><span class="o">.</span><span class="n">login_manager</span><span class="o">.</span><span class="n">login_as_guest</span><span class="p">()</span>
  297. <span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
  298. <span class="k">else</span><span class="p">:</span>
  299. <span class="n">webnotes</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s">&#39;session_status&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;Session Expired&#39;</span>
  300. <span class="k">raise</span> <span class="ne">Exception</span><span class="p">,</span> <span class="s">&#39;Session Expired&#39;</span>
  301. <span class="k">elif</span> <span class="n">r</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="o">==</span><span class="s">&#39;Logged Out&#39;</span><span class="p">:</span>
  302. <span class="n">webnotes</span><span class="o">.</span><span class="n">login_manager</span><span class="o">.</span><span class="n">login_as_guest</span><span class="p">()</span>
  303. <span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
  304. <span class="c"># allow refresh or logout</span>
  305. <span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;cmd&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;cmd&#39;</span><span class="p">)</span><span class="o">!=</span><span class="s">&#39;logout&#39;</span><span class="p">:</span>
  306. <span class="n">webnotes</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s">&#39;session_status&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;Logged Out&#39;</span>
  307. <span class="k">raise</span> <span class="ne">Exception</span><span class="p">,</span> <span class="s">&#39;Logged Out&#39;</span>
  308. <span class="k">else</span><span class="p">:</span>
  309. <span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;data&#39;</span><span class="p">:</span><span class="nb">eval</span><span class="p">(</span><span class="n">r</span><span class="p">[</span><span class="mi">1</span><span class="p">]),</span> <span class="s">&#39;user&#39;</span><span class="p">:</span><span class="n">r</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s">&#39;sid&#39;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">sid</span><span class="p">}</span>
  310. <span class="k">else</span><span class="p">:</span>
  311. <span class="n">webnotes</span><span class="o">.</span><span class="n">login_manager</span><span class="o">.</span><span class="n">login_as_guest</span><span class="p">()</span>
  312. <span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
  313. <span class="c"># start a session</span>
  314. <span class="c"># ---------------</span></div>
  315. <div class="viewcode-block" id="Session.start"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.Session.start">[docs]</a> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  316. <span class="kn">import</span> <span class="nn">os</span>
  317. <span class="kn">import</span> <span class="nn">webnotes</span>
  318. <span class="kn">import</span> <span class="nn">webnotes.utils</span>
  319. <span class="c"># generate sid</span>
  320. <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;user&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">login_manager</span><span class="o">.</span><span class="n">user</span>
  321. <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;sid&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">generate_hash</span><span class="p">()</span>
  322. <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;data&#39;</span><span class="p">][</span><span class="s">&#39;session_ip&#39;</span><span class="p">]</span> <span class="o">=</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;REMOTE_ADDR&#39;</span><span class="p">);</span>
  323. <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;data&#39;</span><span class="p">][</span><span class="s">&#39;tenant_id&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;tenant_id&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
  324. <span class="c"># get ipinfo</span>
  325. <span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">get_global</span><span class="p">(</span><span class="s">&#39;get_ip_info&#39;</span><span class="p">):</span>
  326. <span class="bp">self</span><span class="o">.</span><span class="n">get_ipinfo</span><span class="p">()</span>
  327. <span class="c"># insert session</span>
  328. <span class="k">try</span><span class="p">:</span>
  329. <span class="bp">self</span><span class="o">.</span><span class="n">insert_session_record</span><span class="p">()</span>
  330. <span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
  331. <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">1054</span><span class="p">:</span>
  332. <span class="bp">self</span><span class="o">.</span><span class="n">add_status_column</span><span class="p">()</span>
  333. <span class="bp">self</span><span class="o">.</span><span class="n">insert_session_record</span><span class="p">()</span>
  334. <span class="k">else</span><span class="p">:</span>
  335. <span class="k">raise</span> <span class="n">e</span>
  336. <span class="c"># update profile</span>
  337. <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;UPDATE tabProfile SET last_login = &#39;</span><span class="si">%s</span><span class="s">&#39;, last_ip = &#39;</span><span class="si">%s</span><span class="s">&#39; where name=&#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">now</span><span class="p">(),</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">remote_ip</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;user&#39;</span><span class="p">]))</span>
  338. <span class="c"># set cookies to write</span>
  339. <span class="n">webnotes</span><span class="o">.</span><span class="n">session</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span>
  340. <span class="n">webnotes</span><span class="o">.</span><span class="n">cookie_manager</span><span class="o">.</span><span class="n">set_cookies</span><span class="p">()</span>
  341. <span class="c"># resume session</span>
  342. <span class="c"># --------------</span></div>
  343. <div class="viewcode-block" id="Session.resume"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.Session.resume">[docs]</a> <span class="k">def</span> <span class="nf">resume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  344. <span class="n">pwd</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;pwd&#39;</span><span class="p">)</span>
  345. <span class="n">webnotes</span><span class="o">.</span><span class="n">login_manager</span><span class="o">.</span><span class="n">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;user&#39;</span><span class="p">],</span> <span class="n">pwd</span><span class="p">)</span>
  346. <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;update tabSessions set status=&#39;Active&#39; where sid=</span><span class="si">%s</span><span class="s">&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;sid&#39;</span><span class="p">])</span>
  347. <span class="k">return</span> <span class="s">&#39;Logged In&#39;</span>
  348. <span class="c"># update session</span>
  349. <span class="c"># --------------</span></div>
  350. <div class="viewcode-block" id="Session.update"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.Session.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  351. <span class="c"># update session</span>
  352. <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;update tabSessions set sessiondata=</span><span class="si">%s</span><span class="s">, user=</span><span class="si">%s</span><span class="s">, lastupdate=NOW() where sid=</span><span class="si">%s</span><span class="s">&quot;</span> <span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;data&#39;</span><span class="p">]),</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;user&#39;</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;sid&#39;</span><span class="p">]))</span>
  353. <span class="bp">self</span><span class="o">.</span><span class="n">check_expired</span><span class="p">()</span>
  354. <span class="c"># check expired</span>
  355. <span class="c"># -------------</span></div>
  356. <div class="viewcode-block" id="Session.check_expired"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.Session.check_expired">[docs]</a> <span class="k">def</span> <span class="nf">check_expired</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  357. <span class="c"># in control panel?</span>
  358. <span class="n">exp_sec</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s">&#39;Control Panel&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="s">&#39;session_expiry&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&#39;6:00:00&#39;</span>
  359. <span class="c"># set sessions as expired</span>
  360. <span class="k">try</span><span class="p">:</span>
  361. <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;update from tabSessions where TIMEDIFF(NOW(), lastupdate) &gt; </span><span class="si">%s</span><span class="s"> SET `status`=&#39;Expired&#39;&quot;</span><span class="p">,</span> <span class="n">exp_sec</span><span class="p">)</span>
  362. <span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
  363. <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">1054</span><span class="p">:</span>
  364. <span class="bp">self</span><span class="o">.</span><span class="n">add_status_column</span><span class="p">()</span>
  365. <span class="c"># clear out old sessions</span>
  366. <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;delete from tabSessions where TIMEDIFF(NOW(), lastupdate) &gt; &#39;72:00:00&#39;&quot;</span><span class="p">)</span>
  367. <span class="c"># -----------------------------</span></div>
  368. <div class="viewcode-block" id="Session.add_status_column"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.Session.add_status_column">[docs]</a> <span class="k">def</span> <span class="nf">add_status_column</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  369. <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
  370. <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;alter table tabSessions add column `status` varchar(20)&quot;</span><span class="p">)</span>
  371. <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span>
  372. <span class="c"># Get IP Info from ipinfodb.com</span>
  373. <span class="c"># -----------------------------</span></div>
  374. <div class="viewcode-block" id="Session.get_ipinfo"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.Session.get_ipinfo">[docs]</a> <span class="k">def</span> <span class="nf">get_ipinfo</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  375. <span class="kn">import</span> <span class="nn">os</span>
  376. <span class="k">try</span><span class="p">:</span>
  377. <span class="kn">import</span> <span class="nn">pygeoip</span>
  378. <span class="k">except</span><span class="p">:</span>
  379. <span class="k">return</span>
  380. <span class="n">gi</span> <span class="o">=</span> <span class="n">pygeoip</span><span class="o">.</span><span class="n">GeoIP</span><span class="p">(</span><span class="s">&#39;data/GeoIP.dat&#39;</span><span class="p">)</span>
  381. <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;data&#39;</span><span class="p">][</span><span class="s">&#39;ipinfo&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;countryName&#39;</span><span class="p">:</span> <span class="n">gi</span><span class="o">.</span><span class="n">country_name_by_addr</span><span class="p">(</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;REMOTE_ADDR&#39;</span><span class="p">))}</span>
  382. <span class="c"># -----------------------------</span></div>
  383. <div class="viewcode-block" id="Session.insert_session_record"><a class="viewcode-back" href="../../webnotes.html#webnotes.auth.Session.insert_session_record">[docs]</a> <span class="k">def</span> <span class="nf">insert_session_record</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  384. <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;insert into tabSessions (sessiondata, user, lastupdate, sid, status) values (</span><span class="si">%s</span><span class="s"> , </span><span class="si">%s</span><span class="s">, NOW(), </span><span class="si">%s</span><span class="s">, &#39;Active&#39;)&quot;</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;data&#39;</span><span class="p">]),</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;user&#39;</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s">&#39;sid&#39;</span><span class="p">]))</span>
  385. </div></div>
  386. </pre></div>
  387. </div>
  388. </div>
  389. </div>
  390. <div class="sphinxsidebar">
  391. <div class="sphinxsidebarwrapper">
  392. <p class="logo"><a href="../../index.html">
  393. <img class="logo" src="../../_static/wnflogo200.gif" alt="Logo"/>
  394. </a></p>
  395. <div id="searchbox" style="display: none">
  396. <h3>Quick search</h3>
  397. <form class="search" action="../../search.html" method="get">
  398. <input type="text" name="q" size="18" />
  399. <input type="submit" value="Go" />
  400. <input type="hidden" name="check_keywords" value="yes" />
  401. <input type="hidden" name="area" value="default" />
  402. </form>
  403. <p class="searchtip" style="font-size: 90%">
  404. Enter search terms or a module, class or function name.
  405. </p>
  406. </div>
  407. <script type="text/javascript">$('#searchbox').show(0);</script>
  408. </div>
  409. </div>
  410. <div class="clearer"></div>
  411. </div>
  412. <div class="related">
  413. <h3>Navigation</h3>
  414. <ul>
  415. <li class="right" style="margin-right: 10px">
  416. <a href="../../genindex.html" title="General Index"
  417. >index</a></li>
  418. <li class="right" >
  419. <a href="../../py-modindex.html" title="Python Module Index"
  420. >modules</a> |</li>
  421. <li><a href="../../index.html">WNFramework v1.8 documentation</a> &raquo;</li>
  422. <li><a href="../index.html" >Module code</a> &raquo;</li>
  423. <li><a href="../webnotes.html" >webnotes</a> &raquo;</li>
  424. </ul>
  425. </div>
  426. <div class="footer">
  427. &copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.
  428. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
  429. </div>
  430. </body>
  431. </html>