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/model/triggers.html
Rushabh Mehta b624972f0d added new docs
2011-06-29 14:41:49 +05:30

166 lines
No EOL
15 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.model.triggers &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.model" href="../model.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" >webnotes</a> &raquo;</li>
<li><a href="../model.html" accesskey="U">webnotes.model</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for webnotes.model.triggers</h1><div class="highlight"><pre>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Add, manage, fire triggers (events / observers)</span>
<span class="sd">Standard events called by the framework are &quot;save, submit, cancel&quot;</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">webnotes</span>
<div class="viewcode-block" id="insert_trigger"><a class="viewcode-back" href="../../../webnotes.model.html#webnotes.model.triggers.insert_trigger">[docs]</a><span class="k">def</span> <span class="nf">insert_trigger</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">docname</span><span class="p">,</span> <span class="n">event_name</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
<span class="s">&quot;inserts a new trigger record&quot;</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;DocTrigger&#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">doctype</span>
<span class="n">d</span><span class="o">.</span><span class="n">doc_name</span> <span class="o">=</span> <span class="n">docname</span>
<span class="n">d</span><span class="o">.</span><span class="n">event_name</span> <span class="o">=</span> <span class="n">event_name</span>
<span class="n">d</span><span class="o">.</span><span class="n">method</span> <span class="o">=</span> <span class="n">method</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>
</div>
<div class="viewcode-block" id="add_trigger"><a class="viewcode-back" href="../../../webnotes.model.html#webnotes.model.triggers.add_trigger">[docs]</a><span class="k">def</span> <span class="nf">add_trigger</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">docname</span><span class="p">,</span> <span class="n">event_name</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Add a trigger to an event on a doctype, docname. The specified method will be called.</span>
<span class="sd"> Wild card &#39;*&#39; is allowed in doctype, docname and/or event_name&quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">trigger_exists</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">docname</span><span class="p">,</span> <span class="n">event_name</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
<span class="n">insert_trigger</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">docname</span><span class="p">,</span> <span class="n">event_name</span><span class="p">,</span> <span class="n">method</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">1146</span><span class="p">:</span>
<span class="n">setup</span><span class="p">()</span>
<span class="n">insert_trigger</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">docname</span><span class="p">,</span> <span class="n">event_name</span><span class="p">,</span> <span class="n">method</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span> <span class="k">raise</span> <span class="n">e</span>
</div>
<div class="viewcode-block" id="trigger_exists"><a class="viewcode-back" href="../../../webnotes.model.html#webnotes.model.triggers.trigger_exists">[docs]</a><span class="k">def</span> <span class="nf">trigger_exists</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">docname</span><span class="p">,</span> <span class="n">event_name</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
<span class="s">&quot;returns true if trigger exists&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 tabDocTrigger 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 event_name=</span><span class="si">%s</span><span class="s"> and method=</span><span class="si">%s</span><span class="s">&quot;</span><span class="p">,</span> \
<span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">docname</span><span class="p">,</span> <span class="n">event_name</span><span class="p">,</span> <span class="n">method</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="remove_trigger"><a class="viewcode-back" href="../../../webnotes.model.html#webnotes.model.triggers.remove_trigger">[docs]</a><span class="k">def</span> <span class="nf">remove_trigger</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">docname</span><span class="p">,</span> <span class="n">event_name</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
<span class="s">&quot;Remove a trigger on an event&quot;</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 tabDocTrigger 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 event_name=</span><span class="si">%s</span><span class="s"> and method=</span><span class="si">%s</span><span class="s">&quot;</span><span class="p">,</span> \
<span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">docname</span><span class="p">,</span> <span class="n">event_name</span><span class="p">,</span> <span class="n">method</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="fire_event"><a class="viewcode-back" href="../../../webnotes.model.html#webnotes.model.triggers.fire_event">[docs]</a><span class="k">def</span> <span class="nf">fire_event</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span> <span class="n">event_name</span><span class="p">):</span>
<span class="s">&quot;Fire all triggers on an event and passes the doc to the trigger&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">tl</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;&quot;&quot;select method from tabDocTrigger </span>
<span class="s"> where (doc_type=</span><span class="si">%s</span><span class="s"> or doc_type=&#39;*&#39;)</span>
<span class="s"> and (doc_name=</span><span class="si">%s</span><span class="s"> or doc_name=&#39;*&#39;)</span>
<span class="s"> and (event_name=</span><span class="si">%s</span><span class="s"> or event_name=&#39;*&#39;)&quot;&quot;&quot;</span><span class="p">,</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">event_name</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">1146</span><span class="p">:</span>
<span class="n">setup</span><span class="p">()</span>
<span class="n">tl</span> <span class="o">=</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">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">tl</span><span class="p">:</span>
<span class="n">module</span><span class="p">,</span> <span class="n">method</span> <span class="o">=</span> <span class="s">&#39;.&#39;</span><span class="o">.</span><span class="n">join</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="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)[:</span><span class="o">-</span><span class="mi">1</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="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">exec</span> <span class="s">&#39;from </span><span class="si">%s</span><span class="s"> import </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="n">method</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">locals</span><span class="p">()</span>
<span class="nb">locals</span><span class="p">()[</span><span class="n">method</span><span class="p">](</span><span class="n">doc</span><span class="p">)</span>
<span class="c">#</span>
<span class="c"># setup</span>
<span class="c">#</span></div>
<div class="viewcode-block" id="setup"><a class="viewcode-back" href="../../../webnotes.model.html#webnotes.model.triggers.setup">[docs]</a><span class="k">def</span> <span class="nf">setup</span><span class="p">():</span>
<span class="s">&quot;creates the DocTrigger table from core&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;doctrigger&#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>
<li><a href="../model.html" >webnotes.model</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