seitime-frappe/docs/_build/html/_modules/webnotes/auth.html
2011-06-29 14:41:49 +05:30

520 lines
No EOL
66 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>webnotes.auth &mdash; WNFramework v1.8 documentation</title>
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="WNFramework v1.8 documentation" href="../../index.html" />
<link rel="up" title="webnotes" href="../webnotes.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">WNFramework v1.8 documentation</a> &raquo;</li>
<li><a href="../index.html" >Module code</a> &raquo;</li>
<li><a href="../webnotes.html" accesskey="U">webnotes</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for webnotes.auth</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">webnotes</span>
<span class="kn">import</span> <span class="nn">webnotes.db</span>
<span class="kn">import</span> <span class="nn">webnotes.utils</span>
<span class="kn">import</span> <span class="nn">webnotes.profile</span>
<span class="kn">import</span> <span class="nn">webnotes.defs</span>
<span class="c"># =================================================================================</span>
<span class="c"># HTTPRequest</span>
<span class="c"># =================================================================================</span>
<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>
<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="c"># Get Environment variables</span>
<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>
<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>
<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>
<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>
<span class="c"># load cookies</span>
<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>
<span class="c"># set db</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_db</span><span class="p">()</span>
<span class="c"># check status</span>
<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>
<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>
<span class="k">raise</span> <span class="ne">Exception</span>
<span class="c"># -----------------------------</span>
<span class="c"># start transaction</span>
<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>
<span class="c"># login</span>
<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>
<span class="c"># start session</span>
<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>
<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>
<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>
<span class="c"># write out cookies if sid is supplied (this is a pre-logged in redirect)</span>
<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>
<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>
<span class="c"># run login triggers</span>
<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>
<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>
<span class="c"># load profile</span>
<span class="bp">self</span><span class="o">.</span><span class="n">setup_profile</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">commit</span><span class="p">()</span>
<span class="c"># end transaction</span>
<span class="c"># -----------------------------</span>
<span class="c"># setup profile</span>
<span class="c"># -------------</span>
<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>
<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>
<span class="c"># load the profile data</span>
<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>
<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>
<span class="k">else</span><span class="p">:</span>
<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>
<span class="c"># get account name</span>
<span class="c"># ------------------</span>
</div>
<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>
<span class="c"># login</span>
<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>
<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>
<span class="c"># in form</span>
<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>
<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>
<span class="c"># in cookie</span>
<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>
<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>
<span class="c"># set database login</span>
<span class="c"># ------------------</span>
</div>
<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>
<span class="c"># select based on subdomain</span>
<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>
<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>
<span class="c"># select based on ac_name</span>
<span class="k">else</span><span class="p">:</span>
<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>
<span class="k">if</span> <span class="n">ac_name</span><span class="p">:</span>
<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>\
<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>
<span class="k">else</span><span class="p">:</span>
<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>
<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>
<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>
<span class="c"># =================================================================================</span>
<span class="c"># Login Manager</span>
<span class="c"># =================================================================================</span>
</div></div>
<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>
<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="bp">self</span><span class="o">.</span><span class="n">cp</span> <span class="o">=</span> <span class="bp">None</span>
<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>
<span class="c"># clear cache</span>
<span class="kn">from</span> <span class="nn">webnotes.session_cache</span> <span class="kn">import</span> <span class="n">clear_cache</span>
<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>
<span class="bp">self</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">post_login</span><span class="p">()</span>
<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>
<span class="c"># run triggers, write cookies</span>
<span class="c"># ---------------------------</span>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">validate_ip_address</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">run_trigger</span><span class="p">()</span>
<span class="c"># check password</span>
<span class="c"># --------------</span>
</div>
<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>
<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>
<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>
<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>
<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>
<span class="c"># custom authentication (for single-sign on)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">load_control_panel</span><span class="p">()</span>
<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>
<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>
<span class="c"># check the password</span>
<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>
<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>
<span class="k">else</span><span class="p">:</span>
<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>
<span class="k">if</span> <span class="ow">not</span> <span class="n">p</span><span class="p">:</span>
<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>
<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>
<span class="c"># triggers</span>
<span class="c"># --------</span>
</div>
<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>
<span class="kn">import</span> <span class="nn">webnotes.model.code</span>
<span class="k">try</span><span class="p">:</span>
<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>
<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>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<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>
<span class="c"># --------</span></div>
<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>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">event_handlers</span>
<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>
<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>
<span class="k">return</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="k">pass</span>
<span class="c"># deprecated</span>
<span class="bp">self</span><span class="o">.</span><span class="n">load_control_panel</span><span class="p">()</span>
<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>
<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>
<span class="c"># ip validation</span>
<span class="c"># -------------</span>
</div>
<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>
<span class="k">try</span><span class="p">:</span>
<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>
<span class="k">except</span><span class="p">:</span> <span class="k">return</span>
<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>
<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>
<span class="k">if</span> <span class="n">ret</span> <span class="ow">and</span> <span class="n">ip</span><span class="p">:</span>
<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>
<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>
<span class="c"># login as guest</span>
<span class="c"># --------------</span>
</div>
<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>
<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>
<span class="k">if</span> <span class="ow">not</span> <span class="n">res</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">,</span> <span class="s">&quot;No Guest Access&quot;</span>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">post_login</span><span class="p">()</span>
<span class="c"># Logout</span>
<span class="c"># ------</span>
</div>
<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>
<span class="kn">import</span> <span class="nn">webnotes.model.code</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> <span class="s">&#39;Control Panel&#39;</span><span class="p">)</span>
<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>
<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>
</div>
<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>
<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>
<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>
<span class="c"># =================================================================================</span>
<span class="c"># Cookie Manager</span>
<span class="c"># =================================================================================</span>
</div></div>
<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>
<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="kn">import</span> <span class="nn">Cookie</span>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">get_incoming_cookies</span><span class="p">()</span>
<span class="c"># get incoming cookies</span>
<span class="c"># --------------------</span>
<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>
<span class="kn">import</span> <span class="nn">os</span>
<span class="n">cookies</span> <span class="o">=</span> <span class="p">{}</span>
<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>
<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>
<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>
<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>
<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>
<span class="n">webnotes</span><span class="o">.</span><span class="n">incoming_cookies</span> <span class="o">=</span> <span class="n">cookies</span>
<span class="c"># Set cookies</span>
<span class="c"># -----------</span>
</div>
<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>
<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>
<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>
<span class="c"># ac_name </span>
<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>
<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>
<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>
<span class="c"># sid expires in 3 days</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<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>
<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>
<span class="c"># Set Remember Me</span>
<span class="c"># ---------------</span>
</div>
<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>
<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>
<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>
<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>
<span class="kn">import</span> <span class="nn">datetime</span>
<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>
<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>
<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>
<span class="c"># =================================================================================</span>
<span class="c"># Session </span>
<span class="c"># =================================================================================</span>
</div></div>
<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>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="n">user</span>
<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>
<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>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
<span class="k">return</span>
<span class="bp">self</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="c"># start a session</span>
<span class="c"># ---------------</span>
<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>
<span class="kn">import</span> <span class="nn">webnotes</span>
<span class="n">r</span><span class="o">=</span><span class="bp">None</span>
<span class="k">try</span><span class="p">:</span>
<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>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">add_status_column</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="k">if</span> <span class="n">r</span><span class="p">:</span>
<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>
<span class="c"># ExipredSession</span>
<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>
<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>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<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>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">,</span> <span class="s">&#39;Session Expired&#39;</span>
<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>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
<span class="c"># allow refresh or logout</span>
<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>
<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>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">,</span> <span class="s">&#39;Logged Out&#39;</span>
<span class="k">else</span><span class="p">:</span>
<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>
<span class="k">else</span><span class="p">:</span>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
<span class="c"># start a session</span>
<span class="c"># ---------------</span></div>
<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>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">webnotes</span>
<span class="kn">import</span> <span class="nn">webnotes.utils</span>
<span class="c"># generate sid</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="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>
<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>
<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>
<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>
<span class="c"># get ipinfo</span>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">get_ipinfo</span><span class="p">()</span>
<span class="c"># insert session</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">insert_session_record</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">add_status_column</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">insert_session_record</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="c"># update profile</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;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>
<span class="c"># set cookies to write</span>
<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>
<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>
<span class="c"># resume session</span>
<span class="c"># --------------</span></div>
<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>
<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>
<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>
<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>
<span class="k">return</span> <span class="s">&#39;Logged In&#39;</span>
<span class="c"># update session</span>
<span class="c"># --------------</span></div>
<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>
<span class="c"># update session</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;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>
<span class="bp">self</span><span class="o">.</span><span class="n">check_expired</span><span class="p">()</span>
<span class="c"># check expired</span>
<span class="c"># -------------</span></div>
<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>
<span class="c"># in control panel?</span>
<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>
<span class="c"># set sessions as expired</span>
<span class="k">try</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">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>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">add_status_column</span><span class="p">()</span>
<span class="c"># clear out old sessions</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;delete from tabSessions where TIMEDIFF(NOW(), lastupdate) &gt; &#39;72:00:00&#39;&quot;</span><span class="p">)</span>
<span class="c"># -----------------------------</span></div>
<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>
<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>
<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>
<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>
<span class="c"># Get IP Info from ipinfodb.com</span>
<span class="c"># -----------------------------</span></div>
<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>
<span class="kn">import</span> <span class="nn">os</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">pygeoip</span>
<span class="k">except</span><span class="p">:</span>
<span class="k">return</span>
<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>
<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>
<span class="c"># -----------------------------</span></div>
<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>
<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>
</div></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/wnflogo200.gif" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">WNFramework v1.8 documentation</a> &raquo;</li>
<li><a href="../index.html" >Module code</a> &raquo;</li>
<li><a href="../webnotes.html" >webnotes</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>