Merge lp:~openerp/openobject-addons/share-web-addons into lp:openobject-addons

[Vaibhav Darji]

Web addon for share module.

[Xavier (Open ERP) (xmo-deactivatedaccount)]

Business problems:
* share_root_url is not provided to the share.wizard object, so we don't get any URL (let alone a useable one) to send to the clients

Other than that it seems to work correctly

Technical issues in controllers.py (mostly):
* I don't think `active=False` is necessary in the share module descriptor
* There are a bunch of unused variables and imports in controllers.py (urlparse, cherrypy, TinyDict, filter_domain)
* By the way why is filter_domain sent but not used?
* Usage of **kwargs even though we know perfectly well what is going to be sent. Why not use regular method parameters and have

    def index(self, domain, search_domain, context)

  rather than the current completely opaque signature
* Why send `view_type` in the JS call if it's not used?
* No need for the `proxy` intermediate variable, it's used only once and doesn't make the code any clearer. It should be inlined
* Likewise with `res`, why not inline it into the `actions.execute` call? It provides no value.
* `model` should be renamed to something clearer (what model to what is it?) and maybe made into a module-level constant, it's not like there's much point defining it in the method
* Why not use keyword arguments in the `context.update` call? I don't think the explicit dict is clearer, let alone faster
* What happens if no action is found? E.g. if there is no view_name in the context? Or if there is no action found for that name? Wouldn't everything kind-of blow up? Please check/test (share.wizard seems to require an action_id, and I doubt None or an empty list is going to work). If it can not happen then we might as well not bother with the checking code line 24-26, and if it's going to blow up anyway sooner better than later, save yourself the RPC call. This means again line 24-26 can probably be simplified.

Technical issues in editors.py:
* Why style=right on the link? It's a regular link, it should not be needed.
* Why create a bunch of temp variables in the JS code? Why not just inline them in the dict/object literal? Their ids seem clear enough to understand what they are.
* Because of "fixed" behavior of actions, you should not open new window yourself as you're just opening an action. Framework will manage, so handler should just set the correct @href on the link.
* Don't use an initial @href of `javascript: void(0)`, use `#` or `#share` instead.
* Title of section is no good, what does "Share View" mean? Especially as a sidebar title? Something like "Sharing" is probably more appropriate that way it opens possibility of new modules building on that and adding stuff in the section.

That's pretty much it for now.

review: Needs Fixing

[lp:~openerp/openobject-addons/share-web-addons]

3904. By Vaibhav Darji on 2010-11-15

[FIX] Improved share action method,share url and passed active db in email.

[Vaibhav Darji (vaibhav-openerp)]

Fixed share root url.
Remove unused variables and imports.
Improvement in share web controller.
passed current db params in email.

[Xavier (Open ERP) (xmo-deactivatedaccount)]

* Share root url not fixed, it only sends socket_host and socket_port which results in a returned "share url" of "0.0.0.0:8080". It's not possible to see share with that.

* A number of fixes I asked for were not done, as result for instance point 3 in editors.py issues mean it doesn't work with new action dialogs

* Also in editors.py, $share has no `var`, so is created as a global.

review: Needs Fixing

[lp:~openerp/openobject-addons/share-web-addons]

3905. By Vaibhav Darji on 2010-11-20

[FIX] Fixed share action according to framework,share_root_url.

[Vaibhav Darji (vaibhav-openerp)]

Fixed action and share root url.

[lp:~openerp/openobject-addons/share-web-addons]

3906. By Vaibhav Darji on 2010-11-22

[FIX] Fixed share root url with direct access of user.

[Vaibhav Darji (vaibhav-openerp)]

Fixed share root url. user can direct access using generated share root url.

[lp:~openerp/openobject-addons/share-web-addons]

3907. By Xavier (Open ERP) on 2010-11-22

[REV] alterations to server side of share wizard

3908. By Xavier (Open ERP) on 2010-11-22

[IMP] cleanup JS share button/link

3909. By Xavier (Open ERP) on 2010-11-22

[FIX] share: naming of classes in web module

3910. By Xavier (Open ERP) on 2010-11-22

[IMP] share: cleanup whitespace in web module

3911. By Xavier (Open ERP) on 2010-11-22

[IMP] action: formatting of ShareWizardController.index, bail out early to reduce nesting

3912. By Xavier (Open ERP) on 2010-11-22

[IMP] share: use **kwargs in dict.update call instead of creating a second dict within it

3913. By Xavier (Open ERP) on 2010-11-22

[FIX] share: send correct share_root_url to server action, add dbname to share_root_url so user can actually be logged in if server has multiple dbs

[Xavier (Open ERP) (xmo-deactivatedaccount)]

The server side should *not* be aware of how the web client works, so I backed the last 2 revisions out and moved that functionality to the web client side, fixed the way the share action is handled/called (leaving most of the work to the existing action dispatcher), and cleaned up the code a bit (class names, nesting/conditions, non-optimal usage of dict.update) before merging it.

=== modified file 'share/__openerp__.py'
--- share/__openerp__.py	2010-10-20 12:20:32 +0000
+++ share/__openerp__.py	2010-11-22 06:42:44 +0000
@@ -48,6 +48,7 @@
         'wizard/share_wizard_view.xml'
     ],
     'installable': True,
+    'web': True,
 }
 
 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:

=== added directory 'share/web'
=== added file 'share/web/__init__.py'
--- share/web/__init__.py	1970-01-01 00:00:00 +0000
+++ share/web/__init__.py	2010-11-22 06:42:44 +0000
@@ -0,0 +1,2 @@
+import controllers
+import editors
\ No newline at end of file

=== added file 'share/web/controllers.py'
--- share/web/controllers.py	1970-01-01 00:00:00 +0000
+++ share/web/controllers.py	2010-11-22 06:42:44 +0000
@@ -0,0 +1,31 @@
+from openobject.tools import expose, ast
+from openerp.controllers import actions
+from openerp.utils import rpc
+
+import openerp.controllers
+import cherrypy
+
+
+
+class Piratepad(openerp.controllers.SecuredController):
+    _cp_path = "/share"
+    
+    @expose()
+    def index(self, domain, search_domain, context, name):
+        domain = ast.literal_eval(domain)
+        search_domain = ast.literal_eval(search_domain)
+        domain.extend(search_domain)
+        context = ast.literal_eval(context)
+        view_name = context.get('_terp_view_name') or name
+        if view_name:
+            action_id = rpc.RPCProxy('ir.actions.actions').search([('name','=',view_name)], 0, 0, 0, context)
+            if action_id:
+                action_id = action_id[0]
+                share_model =  'share.wizard'
+                share_root_url = cherrypy.request.base
+
+                share_wiz_id = rpc.RPCProxy('ir.ui.menu').search([('name','=', 'Share Wizard')])
+                context.update({'active_ids': share_wiz_id, 'active_id': share_wiz_id[0], '_terp_view_name': 'Share Wizard', 'share_root_url': share_root_url})
+                sharing_view_id = rpc.RPCProxy(share_model).create({'domain': str(domain), 'action_id':action_id}, context)
+                return actions.execute(rpc.session.execute('object', 'execute', share_model, 'go_step_1', [sharing_view_id], context), ids=[sharing_view_id], context=context)
+

=== added file 'share/web/editors.py'
--- share/web/editors.py	1970-01-01 00:00:00 +0000
+++ share/web/editors.py	2010-11-22 06:42:44 +0000
@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+import openobject.templating
+
+class SidebarTemplateEditor(openobject.templating.TemplateEditor):
+    templates = ['/openerp/widgets/templates/sidebar.mako']
+    ADD_SHARE_BUTTON = u'id="sidebar"'
+
+    def insert_share_link(self, output):
+        # Insert the link on the line right after the link to open the
+        # attachment form
+        form_opener_insertion = output.index(
+                '\n',
+                output.index(self.ADD_SHARE_BUTTON)) + 1
+        output = output[:form_opener_insertion] + \
+                 '''<div id="share-wizard" class="sideheader-a"><h2>${_("Sharing")}</h2></div>
+                     <ul class="clean-a">
+                         <li>
+                             <a id="sharing" href="#share">${_("Share")}</a>
+                         </li>
+                     </ul>
+                       <script type="text/javascript">
+                           jQuery(document).ready(function() {
+                               var $share = jQuery('#sharing').click(function(){
+                                   var _domain =  jQuery('#_terp_domain').val();
+                                   var _search_domain =  jQuery('#_terp_search_domain').val();
+                                   var _context = jQuery('#_terp_context').val();
+                                   var _view_name = jQuery('#_terp_string').val();
+                                   openLink(openobject.http.getURL('/share', {domain: _domain, search_domain: _search_domain, context: _context, name: _view_name}));
+                                   return false;
+                               });
+                           });
+                       </script>
+                       \n''' + \
+                 output[form_opener_insertion:]
+        return output
+
+    def edit(self, template, template_text):
+        output = super(SidebarTemplateEditor, self).edit(template, template_text)
+
+        output = self.insert_share_link(output)
+        return output

=== modified file 'share/wizard/share_wizard.py'
--- share/wizard/share_wizard.py	2010-11-12 16:23:38 +0000
+++ share/wizard/share_wizard.py	2010-11-22 06:42:44 +0000
@@ -98,12 +98,16 @@
             for new_user in wizard_data.new_users.split('\n'):
                 # attempt to show more user-friendly msg than default constraint error
                 existing = user_obj.search(cr, 1, [('login', '=', new_user)])
+                password = generate_random_pass()
+                if wizard_data.share_root_url:
+                    wizard_data.share_root_url = wizard_data.share_root_url + '/openerp/login?db=%s'%(cr.dbname) + '&user=%s'%(new_user) + '&password=%s'%(password)
+                    self.write(cr, 1, [uid], {'share_root_url': wizard_data.share_root_url})
                 if existing:
                     raise osv.except_osv(_('User already exists'),
                                          _('This username (%s) already exists, perhaps data has already been shared with this person.\nYou may want to try selecting existing shared users instead.'))
                 user_id = user_obj.create(cr, 1, {
                         'login': new_user,
-                        'password': generate_random_pass(),
+                        'password': password,
                         'name': new_user,
                         'user_email': new_user,
                         'groups_id': [(6,0,[group_id])],
@@ -394,7 +398,6 @@
         # C.
         all_relations = obj0 + obj1 + obj2 + obj3
         self._link_or_copy_current_user_rules(cr, uid, group_id, all_relations, context=context)
-
         # so far, so good -> populate summary results and return them
         self._create_result_lines(cr, uid, wizard_data, context=context)
 
@@ -426,6 +429,7 @@
                     body += _("You may use the following login and password to get access to this protected area:") + "\n"
                     body += "%s: %s" % (_("Username"), result_line.login) + "\n"
                     body += "%s: %s" % (_("Password"), result_line.password) + "\n"
+                    body += "%s: %s" % (_("Database"), cr.dbname) + "\n"
                 else:
                     body += _("This additional data has been automatically added to your current access.\n")
                     body += _("You may use your existing login and password to view it. As a reminder, your login is %s.\n") % result_line.login