vassili/seitime-frappe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4
seitime-frappe/docs/_build/html/_modules/webnotes/widgets/follow.html
Rushabh Mehta b624972f0d added new docs
2011-06-29 14:41:49 +05:30

230 lines
No EOL
24 KiB
HTML
Raw Blame History

<!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.widgets.follow &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.widgets.follow</h1><div class="highlight"><pre>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Server side methods for the follower pattern (Follow button used in forms)</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">webnotes</span>
<span class="n">form</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span>
<span class="c">#</span>
<span class="c"># Follow</span>
<span class="c">#</span>
<div class="viewcode-block" id="follow"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.follow.follow">[docs]</a><span class="k">def</span> <span class="nf">follow</span><span class="p">(</span><span class="n">dt</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">dn</span><span class="o">=</span><span class="bp">None</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">verbose</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="s">&quot;Add as follower to a particular record. If no parameteres, then take from the http request (form)&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">dt</span><span class="p">:</span>
<span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">,</span> <span class="n">user</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;dt&#39;</span><span class="p">),</span> <span class="n">form</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;dn&#39;</span><span class="p">),</span> <span class="n">form</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;user&#39;</span><span class="p">)</span>
<span class="n">verbose</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">user</span><span class="p">:</span> <span class="k">return</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">is_follower</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">,</span> <span class="n">user</span><span class="p">):</span>
<span class="n">make_follower</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">verbose</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">verbose</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">&quot;</span><span class="si">%s</span><span class="s"> is already a follower!&quot;</span> <span class="o">%</span> <span class="n">user</span><span class="p">)</span>
<span class="k">return</span> <span class="n">load_followers</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="make_follower"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.follow.make_follower">[docs]</a><span class="k">def</span> <span class="nf">make_follower</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">verbose</span><span class="p">):</span>
<span class="s">&quot;Add the user as a follower&quot;</span>
<span class="k">if</span> <span class="n">has_permission</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">user</span><span class="p">):</span>
<span class="kn">from</span> <span class="nn">webnotes.model.doc</span> <span class="kn">import</span> <span class="n">Document</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">Document</span><span class="p">(</span><span class="s">&#39;Follower&#39;</span><span class="p">)</span>
<span class="n">d</span><span class="o">.</span><span class="n">doc_type</span> <span class="o">=</span> <span class="n">dt</span>
<span class="n">d</span><span class="o">.</span><span class="n">doc_name</span> <span class="o">=</span> <span class="n">dn</span>
<span class="n">d</span><span class="o">.</span><span class="n">owner</span> <span class="o">=</span> <span class="n">user</span>
<span class="n">d</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">verbose</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;</span><span class="si">%s</span><span class="s"> does not have sufficient permission to follow&#39;</span> <span class="o">%</span> <span class="n">user</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="has_permission"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.follow.has_permission">[docs]</a><span class="k">def</span> <span class="nf">has_permission</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">user</span><span class="p">):</span>
<span class="s">&quot;Check to see if the user has permission to follow&quot;</span>
<span class="k">return</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 tabDocPerm where parent=</span><span class="si">%s</span><span class="s"> and ifnull(`read`,0)=1 and role in (&#39;</span><span class="si">%s</span><span class="s">&#39;) limit 1&quot;</span> \
<span class="o">%</span> <span class="p">(</span><span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s">&quot;&#39;, &#39;&quot;</span><span class="o">.</span><span class="n">join</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">get_roles</span><span class="p">()))),</span> <span class="n">dt</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="is_follower"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.follow.is_follower">[docs]</a><span class="k">def</span> <span class="nf">is_follower</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">,</span> <span class="n">user</span><span class="p">):</span>
<span class="s">&quot;returns true if given user is a follower&quot;</span>
<span class="k">return</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;&quot;&quot;</span>
<span class="s"> select name from tabFollower </span>
<span class="s"> where ifnull(doc_type,&#39;&#39;)=</span><span class="si">%s</span><span class="s"> </span>
<span class="s"> and ifnull(doc_name,&#39;&#39;)=</span><span class="si">%s</span><span class="s"> </span>
<span class="s"> and owner=</span><span class="si">%s</span><span class="s">&quot;&quot;&quot;</span><span class="p">,</span> <span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">,</span> <span class="n">user</span><span class="p">))</span>
<span class="c">#</span>
<span class="c"># Unfollow</span>
<span class="c">#</span></div>
<div class="viewcode-block" id="unfollow"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.follow.unfollow">[docs]</a><span class="k">def</span> <span class="nf">unfollow</span><span class="p">(</span><span class="n">dt</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">dn</span><span class="o">=</span><span class="bp">None</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="s">&quot;Unfollow a particular record. If no parameteres, then take from the http request (form)&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">dt</span><span class="p">:</span>
<span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">,</span> <span class="n">user</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;dt&#39;</span><span class="p">),</span> <span class="n">form</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;dn&#39;</span><span class="p">),</span> <span class="n">form</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;user&#39;</span><span class="p">)</span>
<span class="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 tabFollower where doc_name=</span><span class="si">%s</span><span class="s"> and doc_type=</span><span class="si">%s</span><span class="s"> and owner=</span><span class="si">%s</span><span class="s">&quot;</span><span class="p">,</span> <span class="p">(</span><span class="n">dn</span><span class="p">,</span> <span class="n">dt</span><span class="p">,</span> <span class="n">user</span><span class="p">))</span>
<span class="k">return</span> <span class="n">load_followers</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">)</span>
<span class="c">#</span>
<span class="c"># Load followers</span>
<span class="c">#</span></div>
<div class="viewcode-block" id="load_followers"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.follow.load_followers">[docs]</a><span class="k">def</span> <span class="nf">load_followers</span><span class="p">(</span><span class="n">dt</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">dn</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="s">&quot;returns list of followers (Full Names) for a particular object&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">dt</span><span class="p">:</span> <span class="n">dt</span><span class="p">,</span> <span class="n">dn</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;dt&#39;</span><span class="p">),</span> <span class="n">form</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;dn&#39;</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</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;&quot;&quot;</span>
<span class="s"> SELECT IFNULL(CONCAT(t1.first_name, if(t1.first_name IS NULL, &#39;&#39;, &#39; &#39;), t1.last_name), t1.name)</span>
<span class="s"> FROM tabProfile t1, tabFollower t2 WHERE t2.doc_type=</span><span class="si">%s</span><span class="s"> AND t2.doc_name=</span><span class="si">%s</span><span class="s"> </span>
<span class="s"> AND t1.name = t2.owner&quot;&quot;&quot;</span><span class="p">,</span> <span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</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="ow">in</span> <span class="p">(</span><span class="mi">1146</span><span class="p">,</span> <span class="mi">1054</span><span class="p">):</span>
<span class="n">setup</span><span class="p">()</span>
<span class="k">return</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">#</span>
<span class="c"># Email followers</span>
<span class="c">#</span></div>
<div class="viewcode-block" id="email_followers"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.follow.email_followers">[docs]</a><span class="k">def</span> <span class="nf">email_followers</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">,</span> <span class="n">msg_html</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">msg_text</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="s">&quot;Send an email to all followers of this object&quot;</span>
<span class="k">pass</span>
<span class="c">#</span>
<span class="c"># Update feed</span>
<span class="c">#</span></div>
<div class="viewcode-block" id="on_docsave"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.follow.on_docsave">[docs]</a><span class="k">def</span> <span class="nf">on_docsave</span><span class="p">(</span><span class="n">doc</span><span class="p">):</span>
<span class="s">&quot;Add the owner and all linked Profiles as followers&quot;</span>
<span class="n">follow</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">doctype</span><span class="p">,</span> <span class="n">doc</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">doc</span><span class="o">.</span><span class="n">owner</span><span class="p">)</span>
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">get_profile_fields</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">doctype</span><span class="p">):</span>
<span class="n">follow</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">doctype</span><span class="p">,</span> <span class="n">doc</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">doc</span><span class="o">.</span><span class="n">fields</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">p</span><span class="p">))</span>
<span class="n">update_followers</span><span class="p">(</span><span class="n">doc</span> <span class="o">=</span> <span class="n">doc</span><span class="p">)</span>
<span class="c">#</span>
<span class="c"># update the follower record timestamp and subject</span>
<span class="c">#</span></div>
<div class="viewcode-block" id="update_followers"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.follow.update_followers">[docs]</a><span class="k">def</span> <span class="nf">update_followers</span><span class="p">(</span><span class="n">dt</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">dn</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">subject</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">update_by</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">doc</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="s">&quot;Updates the timestamp and subject in follower table (for feed generation)&quot;</span>
<span class="kn">from</span> <span class="nn">webnotes.utils</span> <span class="kn">import</span> <span class="n">now</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 tabFollower set modified=</span><span class="si">%s</span><span class="s">, subject=</span><span class="si">%s</span><span class="s">, modified_by=</span><span class="si">%s</span><span class="s"> where doc_type=</span><span class="si">%s</span><span class="s"> and doc_name=</span><span class="si">%s</span><span class="s">&quot;</span><span class="p">,</span> \
<span class="p">(</span><span class="n">now</span><span class="p">(),</span>
<span class="n">subject</span> <span class="ow">or</span> <span class="n">doc</span><span class="o">.</span><span class="n">fields</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;subject&#39;</span><span class="p">),</span> \
<span class="n">update_by</span> <span class="ow">or</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">session</span><span class="p">[</span><span class="s">&#39;user&#39;</span><span class="p">],</span>\
<span class="n">dt</span> <span class="ow">or</span> <span class="n">doc</span><span class="o">.</span><span class="n">doctype</span><span class="p">,</span>
<span class="n">dn</span> <span class="ow">or</span> <span class="n">doc</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
<span class="c">#</span>
<span class="c"># get type of &quot;Profile&quot; fields</span>
<span class="c">#</span></div>
<div class="viewcode-block" id="get_profile_fields"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.follow.get_profile_fields">[docs]</a><span class="k">def</span> <span class="nf">get_profile_fields</span><span class="p">(</span><span class="n">dt</span><span class="p">):</span>
<span class="s">&quot;returns a list of all profile link fields from the doctype&quot;</span>
<span class="k">return</span> <span class="p">[</span><span class="n">f</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</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 fieldname from tabDocField where parent=</span><span class="si">%s</span><span class="s"> and fieldtype=&#39;Link&#39; and options=&#39;Profile&#39;&quot;</span><span class="p">,</span> <span class="n">dt</span><span class="p">)]</span>
<span class="c">#</span>
<span class="c"># setup - make followers table</span>
<span class="c">#</span></div>
<div class="viewcode-block" id="setup"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.follow.setup">[docs]</a><span class="k">def</span> <span class="nf">setup</span><span class="p">():</span>
<span class="s">&quot;Make table for followers - if missing&quot;</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="kn">from</span> <span class="nn">webnotes.modules.module_manager</span> <span class="kn">import</span> <span class="n">reload_doc</span>
<span class="n">reload_doc</span><span class="p">(</span><span class="s">&#39;core&#39;</span><span class="p">,</span> <span class="s">&#39;doctype&#39;</span><span class="p">,</span> <span class="s">&#39;follower&#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">begin</span><span class="p">()</span> </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>
Reference in a new issue View git blame Copy permalink