Merge lp:~elbati/server-env-tools/adding_super_calendar into lp:~server-env-tools-core-editors/server-env-tools/6.1

[Lorenzo Battistini]

Is this project the right place for this module?

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

Hi,

I think that this project "Server Environment And Tools" is supposed to harbor modules which change the OpenERP behavior according to the environment, for example:

 - if the environment is 'dev' send the e-mails to a fake smtp, if it is 'test' do not send them and if it is 'prod' use the production smtp server.

But the 'And Tools' suggest that it can also contain 'tools', but I don't know if they are supposed to be related to the environment or not.
The description of the project deserves to be reworded a little to be more explicative.

[Joël Grand-Guillaume @ camptocamp (jgrandguillaume-c2c)]

Hi Lorenzo,

First, thank you for your contribution ! This project aim to group all server "low level" tools, like handling translation or security.

There is 2 point of view here:

- We consider your module as a server improvement to display in a super calendar all define object => in that case, I can understand it lands here !

- We consider your module is more a project or time management, and in this case, he'd better go to a project or timesheet LP project

What's your opinion here ? Anybody else ?

Regards,

Joël

review: Needs Information

[Nicolas Bessi - Camptocamp (nbessi-c2c-deactivatedaccount)]

Hello,

I think it is more a generic addon than project related addon. I have no objection to merge it here.

Regards

Nicolas

[Niels Huylebroeck (red15)]

On a little side note: you can now specify authors as a list of strings. This way you don't have an infinite amount of combination of partners on the apps site.

I've seen this implemented for some time but the change was quite silent. I would have to go and search to see where exactly they changed it.

So I would suggest you put

  'author': ['Agile Business Group', 'Domsense'],

in your __openerp__.py

(Be sure to check it locally because YMMV)

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

So it seems that's the good place.

Here are my remarks:

102 + 'author': 'Agile Business Group & Domsense',
You may want to change as author list as proposed by Niels. (thanks for the remark by the way I wasn't aware of that, good to know)

17,44,157: what means this All Rights Reserved notice?

174 +from osv import fields, osv
175 +from tools.translate import _
176 +import netsvc
Better to write:
  from openerp.osv import fields, osv, orm
  from openerp.tools.translate import _
  from openerp import netsvc

187,246,283
  class super_calendar_configurator(osv.osv):
Better to write:
  class super_calendar_configurator(orm.Model):

181 +def _models_get(self, cr, uid, context={}):
No mutable in default value for a keyword argument:
  def _models_get(self, cr, uid, context=None):

188 + _logger = netsvc.Logger()
should be replaced by the logging module, netsvc logging output annoying deprecation warnings

203 + for configurator_id in configurator_ids:
204 + configurator = self.browse(cr, uid, configurator_id)
You better have to write:
  for configurator_id in self.browse(cr, uid, configurator_ids, context=context):
Otherwise it have to browse the ids one per one.

207: eval should be replaced by OpenERP's safe_eval, you can do it easily by importing on top of your module:
  from tools.safe_eval import safe_eval as eval

215: the trailing \ is not necessary (and not recommended) within parenthesis

216: one more level of indentation should be used because it mingles with the line below

244,271,288: the models instantiation is not needed anymore

279: to remove?

Globally: the context is never passed in method calls, is it intended?

[Niels Huylebroeck (red15)]

174 : Do we really still need osv ? (See my mail about osv.except_osv vs
orm.except_orm on the community list)
188 : netsvc logging outputs ONLY the annoying message (not the actual
error anymore afaik)
207 : from openerp.tools import safe_eval as eval

[lp:~elbati/server-env-tools/adding_super_calendar]

27. By Lorenzo Battistini on 2013-01-11

[FIX] copyright header

28. By Lorenzo Battistini on 2013-01-11

[FIX] minor fixes

29. By Lorenzo Battistini on 2013-01-11

[FIX] using right logger

30. By Lorenzo Battistini on 2013-01-11

[FIX] orm methods

31. By Lorenzo Battistini on 2013-01-11

[FIX] eval

32. By Lorenzo Battistini on 2013-01-11

[IMP] cleaning

33. By Lorenzo Battistini on 2013-01-11

[FIX] eval

34. By Lorenzo Battistini on 2013-01-11

[FIX] import logging

35. By Lorenzo Battistini on 2013-01-15

[FIX] author name

[Lorenzo Battistini (elbati)]

Hello, just did the changes.
Please review.
Thanks

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

Great, looks good to me.

review: Approve

[Nicolas Bessi - Camptocamp (nbessi-c2c-deactivatedaccount)]

LGTM, merged.

Thanks for the work.

Regards

Nicolas

review: Approve (no test)

=== added directory 'super_calendar'
=== added file 'super_calendar/AUTHORS.txt'
--- super_calendar/AUTHORS.txt	1970-01-01 00:00:00 +0000
+++ super_calendar/AUTHORS.txt	2013-01-15 19:29:21 +0000
@@ -0,0 +1,1 @@
+Lorenzo Battistini <[e-mail]>

=== added file 'super_calendar/__init__.py'
--- super_calendar/__init__.py	1970-01-01 00:00:00 +0000
+++ super_calendar/__init__.py	2013-01-15 19:29:21 +0000
@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#    
+#    Copyright (C) 2012 Agile Business Group sagl (<http://www.agilebg.com>)
+#    Copyright (C) 2012 Domsense srl (<http://www.domsense.com>)
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+import super_calendar

=== added file 'super_calendar/__openerp__.py'
--- super_calendar/__openerp__.py	1970-01-01 00:00:00 +0000
+++ super_calendar/__openerp__.py	2013-01-15 19:29:21 +0000
@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#    
+#    Copyright (C) 2012 Agile Business Group sagl (<http://www.agilebg.com>)
+#    Copyright (C) 2012 Domsense srl (<http://www.domsense.com>)
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+{
+    'name': "Super Calendar",
+    'version': '0.1',
+    'category': 'Generic Modules/Others',
+    'description': """
+This module allows to create configurable calendars.
+
+Through the 'calendar configurator' object, you can specify which models have to be merged in the super calendar. For each model, you have to define the 'description' and 'date_start' fields at least. Then you can define 'duration' and the 'user_id' fields.
+
+The 'super.calendar' object contains the the merged calendars. The 'super.calendar' can be updated by 'ir.cron' or manually.
+
+Configuration
+=============
+
+After installing the module you can go to
+
+Super calendar → Configuration → Configurators
+
+and create a new configurator. For instance, if you want to see meetings and phone calls, you can create the following lines
+
+.. image:: http://planet.domsense.com/wp-content/uploads/2012/04/meetings.png
+   :width: 400 px
+
+.. image:: http://planet.domsense.com/wp-content/uploads/2012/04/phone_calls.png
+   :width: 400 px
+
+Then, you can use the ‘Generate Calendar’ button or wait for the scheduled action (‘Generate Calendar Records’) to be run.
+
+When the calendar is generated, you can visualize it by the ‘super calendar’ main menu.
+
+Here is a sample monthly calendar:
+
+.. image:: http://planet.domsense.com/wp-content/uploads/2012/04/month_calendar.png
+   :width: 400 px
+
+And here is the weekly one:
+
+.. image:: http://planet.domsense.com/wp-content/uploads/2012/04/week_calendar.png
+   :width: 400 px
+
+As you can see, several filters are available. A typical usage consists in filtering by ‘Configurator’ (if you have several configurators, ‘Scheduled calls and meetings’ can be one of them) and by your user. Once you filtered, you can save the filter as ‘Advanced filter’ or even add it to a dashboard.
+""",
+    'author': 'Agile Business Group',
+    'website': 'http://www.agilebg.com',
+    'license': 'AGPL-3',
+    "depends" : ['base'],
+    "init_xml" : [],
+    "update_xml" : [
+        'super_calendar_view.xml',
+        'cron_data.xml',
+        'security/ir.model.access.csv',
+        ],
+    "demo_xml" : [],
+    "active": False,
+    "installable": True
+}

=== added file 'super_calendar/cron_data.xml'
--- super_calendar/cron_data.xml	1970-01-01 00:00:00 +0000
+++ super_calendar/cron_data.xml	2013-01-15 19:29:21 +0000
@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<openerp>
+    <data noupdate="1">
+        <record model="ir.cron" id="generate_calendar_records_cron">
+            <field name="name">Generate Calendar Records</field>
+            <field name="interval_number">10</field>
+            <field name="interval_type">minutes</field>
+            <field name="numbercall">-1</field>
+            <field name="doall" eval="False"></field>
+            <field eval="'super.calendar.configurator'" name="model"/>
+            <field eval="'generate_calendar_records'" name="function"/>
+            <field eval="'[[],{}]'" name="args"/>
+        </record>
+    </data>
+</openerp>

=== added directory 'super_calendar/i18n'
=== added directory 'super_calendar/security'
=== added file 'super_calendar/security/ir.model.access.csv'
--- super_calendar/security/ir.model.access.csv	1970-01-01 00:00:00 +0000
+++ super_calendar/security/ir.model.access.csv	2013-01-15 19:29:21 +0000
@@ -0,0 +1,4 @@
+id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
+access_model_super_calendar_configurator,access_model_super_calendar_configurator,model_super_calendar_configurator,base.group_system,1,1,1,1
+access_model_super_calendar_configurator_line,access_model_super_calendar_configurator_line,model_super_calendar_configurator_line,base.group_system,1,1,1,1
+access_model_super_calendar,access_model_super_calendar,model_super_calendar,base.group_user,1,0,0,0

=== added file 'super_calendar/super_calendar.py'
--- super_calendar/super_calendar.py	1970-01-01 00:00:00 +0000
+++ super_calendar/super_calendar.py	2013-01-15 19:29:21 +0000
@@ -0,0 +1,132 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#    
+#    Copyright (C) 2012 Agile Business Group sagl (<http://www.agilebg.com>)
+#    Copyright (C) 2012 Domsense srl (<http://www.domsense.com>)
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+from openerp.osv import fields, osv, orm
+from openerp.tools.translate import _
+import logging
+from mako.template import Template
+from datetime import datetime
+from openerp import tools
+from openerp.tools import safe_eval as eval
+
+def _models_get(self, cr, uid, context=None):
+    obj = self.pool.get('ir.model')
+    ids = obj.search(cr, uid, [])
+    res = obj.read(cr, uid, ids, ['model', 'name'], context)
+    return [(r['model'], r['name']) for r in res]
+
+class super_calendar_configurator(orm.Model):
+    _logger = logging.getLogger('super.calendar')
+    _name = 'super.calendar.configurator'
+    _columns  = {
+        'name': fields.char('Name', size=64, required=True),
+        'line_ids': fields.one2many('super.calendar.configurator.line', 'configurator_id', 'Lines'),
+        }
+
+    def generate_calendar_records(self, cr, uid, ids, context=None):
+        configurator_ids = self.search(cr, uid, [])
+        super_calendar_pool = self.pool.get('super.calendar')
+        
+        # removing old records
+        super_calendar_ids = super_calendar_pool.search(cr, uid, [], context=context)
+        super_calendar_pool.unlink(cr, uid, super_calendar_ids, context=context)
+        
+        for configurator in self.browse(cr, uid, configurator_ids, context):
+            for line in configurator.line_ids:
+                current_pool = self.pool.get(line.name.model)
+                current_record_ids = current_pool.search(cr, uid, line.domain and eval(line.domain) or [], context=context)
+                for current_record_id in current_record_ids:
+                    current_record  = current_pool.browse(cr, uid, current_record_id, context=context)
+                    if line.user_field_id and \
+                        current_record[line.user_field_id.name] and current_record[line.user_field_id.name]._table_name != 'res.users':
+                        raise osv.except_osv(_('Error'), 
+                            _("The 'User' field of record %s (%s) does not refer to res.users")
+                            % (current_record[line.description_field_id.name], line.name.model))
+                    if (((line.description_field_id
+                        and current_record[line.description_field_id.name])
+                        or line.description_code)
+                        and current_record[line.date_start_field_id.name]):
+                        duration = False
+                        if not line.duration_field_id and line.date_stop_field_id and current_record[line.date_start_field_id.name] and current_record[line.date_stop_field_id.name]:
+                            date_start= datetime.strptime(current_record[line.date_start_field_id.name], tools.DEFAULT_SERVER_DATETIME_FORMAT)
+                            date_stop= datetime.strptime(current_record[line.date_stop_field_id.name], tools.DEFAULT_SERVER_DATETIME_FORMAT)
+                            duration = (date_stop - date_start).total_seconds() / 3600
+                        elif line.duration_field_id:
+                            duration = current_record[line.duration_field_id.name]
+                        if line.description_type != 'code':
+                            name = current_record[line.description_field_id.name]
+                        else:
+                            parse_dict = {'o': current_record}
+                            mytemplate = Template(line.description_code)
+                            name= mytemplate.render(**parse_dict)
+                        super_calendar_values = {
+                            'name': name,
+                            'model_description': line.description,
+                            'date_start': current_record[line.date_start_field_id.name],
+                            'duration': duration,
+                            'user_id': line.user_field_id and current_record[line.user_field_id.name] and current_record[line.user_field_id.name].id or False,
+                            'configurator_id': configurator.id,
+                            'res_id': line.name.model+','+str(current_record['id']),
+                            'model_id': line.name.id,
+                            }
+                        super_calendar_pool.create(cr, uid, super_calendar_values, context=context)
+        self._logger.info('Calendar generated')
+        return True
+
+
+class super_calendar_configurator_line(orm.Model):
+    _name = 'super.calendar.configurator.line'
+    _columns  = {
+        'name': fields.many2one('ir.model', 'Model', required=True),
+        'description': fields.char('Description', size=128, required=True),
+        'domain': fields.char('Domain', size=512),
+        'configurator_id': fields.many2one('super.calendar.configurator', 'Configurator'),
+        'description_type': fields.selection([
+            ('field', 'Field'),
+            ('code', 'Code'),
+            ], string="Description Type"),
+        'description_field_id': fields.many2one('ir.model.fields', 'Description field',
+            domain="[('model_id', '=', name),('ttype', '=', 'char')]"),
+        'description_code': fields.text('Description field', help="Use '${o}' to refer to the involved object. E.g.: '${o.project_id.name}'"),
+        'date_start_field_id': fields.many2one('ir.model.fields', 'Start date field',
+            domain="['&','|',('ttype', '=', 'datetime'),('ttype', '=', 'date'),('model_id', '=', name)]",
+            required=True),
+        'date_stop_field_id': fields.many2one('ir.model.fields', 'End date field',
+            domain="['&',('ttype', '=', 'datetime'),('model_id', '=', name)]"),
+        'duration_field_id': fields.many2one('ir.model.fields', 'Duration field',
+            domain="['&',('ttype', '=', 'float'),('model_id', '=', name)]"),
+        'user_field_id': fields.many2one('ir.model.fields', 'User field',
+            domain="['&',('ttype', '=', 'many2one'),('model_id', '=', name)]"),
+        }
+        
+
+class super_calendar(orm.Model):
+    _name = 'super.calendar'
+    _columns  = {
+        'name': fields.char('Description', size=512, required=True),
+        'model_description': fields.char('Model Description', size=128, required=True),
+        'date_start':fields.datetime('Start date', required=True),
+        'duration':fields.float('Duration'),
+        'user_id': fields.many2one('res.users', 'User'),
+        'configurator_id': fields.many2one('super.calendar.configurator', 'Configurator'),
+        'res_id': fields.reference('Resource', selection=_models_get, size=128),
+        'model_id': fields.many2one('ir.model', 'Model'),
+        }

=== added file 'super_calendar/super_calendar_view.xml'
--- super_calendar/super_calendar_view.xml	1970-01-01 00:00:00 +0000
+++ super_calendar/super_calendar_view.xml	2013-01-15 19:29:21 +0000
@@ -0,0 +1,146 @@
+<?xml version="1.0"?>
+<openerp>
+    <data>
+        
+        <!-- configurator -->
+        
+        <record model="ir.ui.view" id="super_calendar_configurator_tree">
+            <field name="name">super_calendar_configurator_tree</field>
+            <field name="model">super.calendar.configurator</field>
+            <field name="type">tree</field>
+            <field name="arch" type="xml">
+                <tree string="Configurators">
+                    <field name="name"/>
+                </tree>
+            </field>
+        </record>
+        <record model="ir.ui.view" id="super_calendar_configurator_form">
+            <field name="name">super_calendar_configurator_form</field>
+            <field name="model">super.calendar.configurator</field>
+            <field name="type">form</field>
+            <field name="arch" type="xml">
+                <form string="Configurator">
+                    <field name="name" select="1" colspan="2"/>
+                    <newline/>
+                    <field name="line_ids" nolabel="1" colspan="4">
+                        <tree string="Lines">
+                            <field name="name"/>
+                            <field name="domain"/>
+                        </tree>
+                        <form string="Line">
+                            <field name="name"/>
+                            <field name="description"/>
+                            <field name="domain"/>
+                            <field name="date_start_field_id"/>
+                            <field name="duration_field_id"/>
+                            <field name="date_stop_field_id" attrs="{'readonly':[('duration_field_id','!=',False)]}"/>
+                            <field name="user_field_id"/>
+                            <separator string="Description" colspan="4" />
+                            <field name="description_type"/>
+                            <newline/>
+                            <field name="description_field_id" attrs="{'required':[('description_type','!=','code')], 'invisible':[('description_type','==','code')]}"/>
+                            <group colspan="4" col="1" attrs="{'invisible':[('description_type','!=','code')]}">
+                                <label  string="Use '${o}' to refer to the involved object. E.g.: '${o.project_id.name}'" />
+                                <field name="description_code" nolabel="1" attrs="{'required':[('description_type','==','code')]}"/>
+                            </group>
+                        </form>
+                    </field>
+                    <newline/>
+                    <button name="generate_calendar_records" string="Generate Calendar" type="object" icon="gtk-go-forward" colspan="2"/>
+                </form>
+            </field>
+        </record>
+        
+        <record model="ir.actions.act_window" id="super_calendar_configurator">
+            <field name="name">Calendar Configurators</field>
+            <field name="res_model">super.calendar.configurator</field>
+            <field name="view_type">form</field>
+            <field name="view_mode">tree,form</field>
+            <field name="view_id" ref="super_calendar_configurator_tree"/>
+        </record>
+        
+        <!-- calendar -->
+        
+        <record model="ir.ui.view" id="super_calendar_tree">
+            <field name="name">super_calendar_tree</field>
+            <field name="model">super.calendar</field>
+            <field name="type">tree</field>
+            <field name="arch" type="xml">
+                <tree string="Calendar">
+                    <field name="name"/>
+                    <field name="date_start"/>
+                    <!--<field name="date_stop"/>-->
+                    <field name="duration"/>
+                    <field name="user_id"/>
+                    <field name="configurator_id"/>
+                    <field name="model_id"/>
+                    <field name="model_description"/>
+                </tree>
+            </field>
+        </record>
+        <record model="ir.ui.view" id="super_calendar_form">
+            <field name="name">super_calendar_form</field>
+            <field name="model">super.calendar</field>
+            <field name="type">form</field>
+            <field name="arch" type="xml">
+                <form string="Configurator">
+                    <field name="name" readonly="1"/>
+                    <field name="date_start" readonly="1"/>
+                    <!--<field name="date_stop" readonly="1"/>-->
+                    <field name="duration" readonly="1"/>
+                    <field name="user_id" readonly="1"/>
+                    <field name="configurator_id" readonly="1"/>
+                    <field name="model_id" readonly="1"/>
+                    <field name="model_description" readonly="1"/>
+                    <field name="res_id"/>
+                </form>
+            </field>
+        </record>
+        <record model="ir.ui.view" id="super_calendar">
+            <field name="name">super_calendar</field>
+            <field name="model">super.calendar</field>
+            <field name="type">calendar</field>
+            <field name="arch" type="xml">
+                <calendar string="Calendar" color="model_description" date_start="date_start" date_delay="duration">
+                    <field name="name"/>
+                </calendar>
+            </field>
+        </record>
+        <record model="ir.ui.view" id="super_calendar_search">
+            <field name="name">super_calendar_search</field>
+            <field name="model">super.calendar</field>
+            <field name="type">search</field>
+            <field name="arch" type="xml">
+                <search string="Search Calendar" >
+                    <field name="name"/>
+                    <field name="configurator_id" select="1"/>
+                    <field name="model_id" select="1"/>
+                    <field name="model_description" select="1"/>
+                    <field name="user_id" widget="selection" >
+                        <filter domain="[('user_id','=',uid)]" help="My Items" icon="terp-personal"/>
+                    </field>
+                    <newline/>
+                    <group expand="0" string="Extended Filters..." colspan="4" col="8">
+                        <field name="date_start" />
+                        <!--<field name="date_stop" />-->
+                        <field name="duration" />
+                    </group>
+                </search>
+            </field>
+        </record>
+        
+        <record model="ir.actions.act_window" id="super_calendar_action">
+            <field name="name">Super Calendar</field>
+            <field name="res_model">super.calendar</field>
+            <field name="view_type">form</field>
+            <field name="view_mode">calendar,tree,form</field>
+            <field name="view_id" ref="super_calendar"/>
+        </record>
+    
+        <menuitem id="super_calendar_menu" name="Super Calendar" action="super_calendar_action"/>
+        <menuitem id="super_calendar_calendar" name="Calendar" parent="super_calendar_menu" />
+        <menuitem id="super_calendar_calendar_calendar" name="Calendar" parent="super_calendar_calendar" action="super_calendar_action"/>
+        <menuitem id="super_calendar_configuration" name="Configuration" parent="super_calendar_menu" />
+        <menuitem id="super_calendar_configurators" name="Configurators" parent="super_calendar_configuration" action="super_calendar_configurator"/>
+    </data>
+</openerp>