[MERGE]: Merge with lp:openobject-trunk-dev-addons2
[odoo/odoo.git] / addons / idea / idea.py
index dff0aa5..b7b7840 100644 (file)
@@ -2,7 +2,7 @@
 ##############################################################################
 #
 #    OpenERP, Open Source Management Solution
-#    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
+#    Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU Affero General Public License as
 #
 ##############################################################################
 
-from osv import osv, fields
+from osv import osv
+from osv import fields
+from tools.translate import _
+import time
 
-VoteValues = [('-1','Not Voted'),('0','Very Bad'),('25', 'Bad'),('50','Normal'),('75','Good'),('100','Very Good') ]
+VoteValues = [('-1', 'Not Voted'), ('0', 'Very Bad'), ('25', 'Bad'), \
+              ('50', 'Normal'), ('75', 'Good'), ('100', 'Very Good') ]
 DefaultVoteValue = '50'
 
 class idea_category(osv.osv):
+    """ Category of Idea """
+
     _name = "idea.category"
-    _description = "Category for an idea"
+    _description = "Idea Category"
+
     _columns = {
         'name': fields.char('Category', size=64, required=True),
         'summary': fields.text('Summary'),
-        'parent_id': fields.many2one('idea.category','Parent Categories', ondelete='set null'),
-        'child_ids': fields.one2many('idea.category','parent_id','Child Categories')
+        'parent_id': fields.many2one('idea.category', 'Parent Categories', ondelete='set null'),
+        'child_ids': fields.one2many('idea.category', 'parent_id', 'Child Categories'),
+        'visibility':fields.boolean('Open Idea?', required=False, help="If True creator of the idea will be visible to others"),
     }
     _sql_constraints = [
         ('name', 'unique(parent_id,name)', 'The name of the category must be unique' )
     ]
     _order = 'parent_id,name asc'
+
 idea_category()
 
 class idea_idea(osv.osv):
+    """ Idea """
     _name = 'idea.idea'
-    _rec_name = 'title'
+    _rec_name = 'name'
 
     def _vote_avg_compute(self, cr, uid, ids, name, arg, context = None):
-        if not len(ids):
+
+        """ compute average for voting
+         @param cr: the current row, from the database cursor,
+         @param uid: the current user’s ID for security checks,
+         @param ids: List of voting’s IDs
+         @return: dictionay of Idea """
+
+        if not ids:
             return {}
-        cr.execute(""" select i.id, avg(v.score::integer)
-                    from idea_idea i left outer join idea_vote v on i.id = v.idea_id
-                    where i.id =ANY(%s)
-                    group by i.id """,(ids,))
+
+        sql = """SELECT i.id, avg(v.score::integer)
+           FROM idea_idea i LEFT OUTER JOIN idea_vote v ON i.id = v.idea_id
+            WHERE i.id IN %s
+            GROUP BY i.id
+        """
+
+        cr.execute(sql, (tuple(ids),))
         return dict(cr.fetchall())
 
-    def _vote_count(self,cr,uid,ids,name,arg,context=None):
-        if not len(ids):
+    def _vote_count(self, cr, uid, ids, name, arg, context=None):
+
+        """ count number of vote
+         @param cr: the current row, from the database cursor,
+         @param uid: the current user’s ID for security checks,
+         @param ids: List of voting count’s IDs
+         @return: dictionay of Idea """
+
+        if not ids:
             return {}
-        cr.execute("""select i.id, count(1)
-                   from idea_idea i left outer join idea_vote v on i.id = v.idea_id
-                    where i.id =ANY(%s)
-                    group by i.id""",(ids,))
+
+        sql = """SELECT i.id, COUNT(1)
+           FROM idea_idea i LEFT OUTER JOIN idea_vote v ON i.id = v.idea_id
+            WHERE i.id IN %s
+            GROUP BY i.id
+        """
+
+        cr.execute(sql, (tuple(ids),))
         return dict(cr.fetchall())
 
-    def _comment_count(self,cr,uid,ids,name,arg,context=None):
-        if not len(ids):
+    def _comment_count(self, cr, uid, ids, name, arg, context=None):
+
+        """ count number of comment
+        @param cr: the current row, from the database cursor,
+        @param uid: the current user’s ID for security checks,
+        @param ids: List of comment’s IDs
+        @return: dictionay of Idea """
+
+        if not ids:
             return {}
-        cr.execute("""select i.id, count(1)
-                   from idea_idea i left outer join idea_comment c on i.id = c.idea_id
-                    where i.id =ANY(%s)
-                    group by i.id""",(ids,))
+
+        sql = """SELECT i.id, COUNT(1)
+           FROM idea_idea i LEFT OUTER JOIN idea_comment c ON i.id = c.idea_id
+            WHERE i.id IN %s
+            GROUP BY i.id
+        """
+
+        cr.execute(sql, (tuple(ids),))
         return dict(cr.fetchall())
 
     def _vote_read(self, cr, uid, ids, name, arg, context = None):
+
+        """ Read Vote
+        @param cr: the current row, from the database cursor,
+        @param uid: the current user’s ID for security checks,
+        @param ids: List of vote read’s IDs """
+
         res = {}
         for id in ids:
             res[id] = '-1'
         vote_obj = self.pool.get('idea.vote')
         votes_ids = vote_obj.search(cr, uid, [('idea_id', 'in', ids), ('user_id', '=', uid)])
-        for vote in vote_obj.browse(cr, uid, votes_ids, context):
+        vote_obj_id = vote_obj.browse(cr, uid, votes_ids, context)
+
+        for vote in vote_obj_id:
             res[vote.idea_id.id] = vote.score
         return res
 
     def _vote_save(self, cr, uid, id, field_name, field_value, arg, context = None):
+
+        """ save Vote
+        @param cr: the current row, from the database cursor,
+        @param uid: the current user’s ID for security checks,
+        @param ids: List of vote save’s IDs """
+
         vote_obj = self.pool.get('idea.vote')
-        vote = vote_obj.search(cr,uid,[('idea_id', '=', id),('user_id', '=', uid)])
+        vote = vote_obj.search(cr, uid, [('idea_id', '=', id), ('user_id', '=', uid)])
         textual_value = str(field_value)
+
         if vote:
-            if int(field_value)>=0:
-                vote_obj.write(cr,uid, vote, { 'score' : textual_value })
+            if int(field_value) >= 0:
+                vote_obj.write(cr, uid, vote, {'score': textual_value })
             else:
-                vote_obj.unlink(cr,uid, vote)
+                vote_obj.unlink(cr, uid, vote)
         else:
-            if int(field_value)>=0:
-                vote_obj.create(cr,uid, { 'idea_id' : id, 'user_id' : uid, 'score' : textual_value })
-
+            if int(field_value) >= 0:
+                vote_obj.create(cr, uid, {'idea_id': id, 'user_id': uid, 'score': textual_value })
 
     _columns = {
         'user_id': fields.many2one('res.users', 'Creator', required=True, readonly=True),
-        'title': fields.char('Idea Summary', size=64, required=True),
-        'description': fields.text('Description', required=True, help='Content of the idea'),
+        'name': fields.char('Idea Summary', size=64, required=True, readonly=True, oldname='title', states={'draft':[('readonly',False)]}),
+        'description': fields.text('Description', help='Content of the idea', readonly=True, states={'draft':[('readonly',False)]}),
         'comment_ids': fields.one2many('idea.comment', 'idea_id', 'Comments'),
-        'create_date' : fields.datetime( 'Creation date', readonly=True),
-        'vote_ids' : fields.one2many('idea.vote', 'idea_id', 'Vote'),
-        'my_vote' : fields.function(_vote_read, fnct_inv = _vote_save, string="My Vote", method=True, type="selection", selection=VoteValues),
-        'vote_avg' : fields.function(_vote_avg_compute, method=True, string="Average Score", type="float"),
-        'count_votes' : fields.function(_vote_count, method=True, string="Count of votes", type="integer"),
+        'created_date': fields.datetime('Creation date', readonly=True),
+        'open_date': fields.datetime('Open date', readonly=True, help="Date when an idea opened"),
+        'vote_ids': fields.one2many('idea.vote', 'idea_id', 'Vote'),
+        'my_vote': fields.function(_vote_read, fnct_inv = _vote_save, string="My Vote", method=True, type="selection", selection=VoteValues),
+        'vote_avg': fields.function(_vote_avg_compute, method=True, string="Average Score", type="float"),
+        'count_votes': fields.function(_vote_count, method=True, string="Count of votes", type="integer"),
         'count_comments': fields.function(_comment_count, method=True, string="Count of comments", type="integer"),
-        'category_id': fields.many2one('idea.category', 'Category', required=True ),
-        'state': fields.selection([('draft','Draft'),('open','Opened'),('close','Accepted'),('cancel','Cancelled')], 'Status', readonly=True),
+        'category_id': fields.many2one('idea.category', 'Category', required=True, readonly=True, states={'draft':[('readonly',False)]}),
+        'state': fields.selection([('draft', 'Draft'),
+            ('open', 'Opened'),
+            ('close', 'Accepted'),
+            ('cancel', 'Refused')],
+            'State', readonly=True,
+            help='When the Idea is created the state is \'Draft\'.\n It is \
+            opened by the user, the state is \'Opened\'.\
+            \nIf the idea is accepted, the state is \'Accepted\'.'
+        ),
+        'visibility':fields.boolean('Open Idea?', required=False),
         'stat_vote_ids': fields.one2many('idea.vote.stat', 'idea_id', 'Statistics', readonly=True),
+        'vote_limit': fields.integer('Maximum Vote per User',
+                     help="Set to one if  you require only one Vote per user"),
     }
 
     _defaults = {
         'user_id': lambda self,cr,uid,context: uid,
         'my_vote': lambda *a: '-1',
-        'state': lambda *a: 'draft'
+        'state': lambda *a: 'draft',
+        'vote_limit': lambda * a: 1,
+        'created_date': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
+        'visibility': lambda *a: True,
     }
     _order = 'id desc'
 
+    def create(self, cr, user, vals, context={}):
+        """
+        Create a new record for a model idea_idea
+        @param cr: A database cursor
+        @param user: ID of the user currently logged in
+        @param vals: provides data for new record
+        @param context: context arguments, like lang, time zone
+
+        @return: Returns an id of the new record
+        """
+        visibility = False
+
+        if vals.get('category_id', False):
+            category_pool = self.pool.get('idea.category')
+            category = category_pool.browse(cr, user, vals.get('category_id'), context)
+            visibility = category.visibility
+
+        vals.update({
+            'visibility':visibility
+        })
+
+        res_id = super(idea_idea, self).create(cr, user, vals, context)
+        return res_id
+
+    def copy(self, cr, uid, id, default={}, context={}):
+        """
+        Create the new record in idea_idea model from existing one
+        @param cr: A database cursor
+        @param user: ID of the user currently logged in
+        @param id: list of record ids on which copy method executes
+        @param default: dict type contains the values to be overridden during copy of object
+        @param context: context arguments, like lang, time zone
+
+        @return: Returns the id of the new record
+        """
+
+        default.update({
+            'comment_ids':False,
+            'vote_ids':False,
+            'stat_vote_ids':False
+
+        })
+        res_id = super(idea_idea, self).copy(cr, uid, id, default, context)
+        return res_id
+
+    def write(self, cr, user, ids, vals, context=None):
+        """
+        Update redord(s) exist in {ids}, with new value provided in {vals}
+
+        @param cr: A database cursor
+        @param user: ID of the user currently logged in
+        @param ids: list of record ids to update
+        @param vals: dict of new values to be set
+        @param context: context arguments, like lang, time zone
+
+        @return: Returns True on success, False otherwise
+        """
+
+        state = self.browse(cr, user, ids[0]).state
+
+        if vals.get('my_vote', False):
+            if vals.get('state', state) != 'open':
+                raise osv.except_osv(_("Warning !"), _("Draft/Accepted/Cancelled ideas Could not be voted"))
+
+        res = super(idea_idea, self).write(cr, user, ids, vals, context)
+        return res
+
     def idea_cancel(self, cr, uid, ids):
-        self.write(cr, uid, ids, { 'state' : 'cancel' })
+        self.write(cr, uid, ids, { 'state': 'cancel' })
         return True
 
     def idea_open(self, cr, uid, ids):
-        self.write(cr, uid, ids, { 'state' : 'open' })
+        self.write(cr, uid, ids, { 'state': 'open' ,'open_date': time.strftime('%Y-%m-%d %H:%M:%S')})
         return True
 
     def idea_close(self, cr, uid, ids):
-        self.write(cr, uid, ids, { 'state' : 'close' })
+        self.write(cr, uid, ids, { 'state': 'close' })
         return True
 
     def idea_draft(self, cr, uid, ids):
-        self.write(cr, uid, ids, { 'state' : 'draft' })
+        self.write(cr, uid, ids, { 'state': 'draft' })
         return True
 idea_idea()
 
+
 class idea_comment(osv.osv):
+    """ Apply Idea for Comment """
+
     _name = 'idea.comment'
-    _description = 'Comments'
+    _description = 'Comment'
     _rec_name = 'content'
+
     _columns = {
-        'idea_id': fields.many2one('idea.idea', 'Idea', required=True, ondelete='cascade' ),
-        'user_id': fields.many2one('res.users', 'User', required=True ),
-        'content': fields.text( 'Comment', required=True ),
-        'create_date' : fields.datetime( 'Creation date', readonly=True),
+        'idea_id': fields.many2one('idea.idea', 'Idea', required=True, ondelete='cascade'),
+        'user_id': fields.many2one('res.users', 'User', required=True),
+        'content': fields.text('Comment', required=True),
+        'create_date': fields.datetime('Creation date', readonly=True),
     }
+
     _defaults = {
         'user_id': lambda self, cr, uid, context: uid
     }
+
     _order = 'id desc'
+
 idea_comment()
 
+
 class idea_vote(osv.osv):
+    """ Apply Idea for Vote """
+
     _name = 'idea.vote'
+    _description = 'Idea Vote'
     _rec_name = 'score'
+
     _columns = {
-        'user_id': fields.many2one( 'res.users', 'User'),
-        'idea_id': fields.many2one('idea.idea', 'Idea', required=True, ondelete='cascade'),
-        'score': fields.selection( VoteValues, 'Score', required=True)
+        'user_id': fields.many2one('res.users', 'User', readonly="True"),
+        'idea_id': fields.many2one('idea.idea', 'Idea', readonly="True", ondelete='cascade'),
+        'score': fields.selection(VoteValues, 'Vote Status', readonly="True"),
+        'date': fields.datetime('Date', readonly="True"),
+        'comment': fields.text('Comment', readonly="True"),
     }
     _defaults = {
         'score': lambda *a: DefaultVoteValue,
+        'date': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
     }
+
 idea_vote()
 
 class idea_vote_stat(osv.osv):
+    """ Idea votes Statistics """
+
     _name = 'idea.vote.stat'
     _description = 'Idea Votes Statistics'
     _auto = False
     _rec_name = 'idea_id'
+
     _columns = {
         'idea_id': fields.many2one('idea.idea', 'Idea', readonly=True),
-        'score': fields.selection( VoteValues, 'Score', readonly=True),
+        'score': fields.selection(VoteValues, 'Score', readonly=True),
         'nbr': fields.integer('Number of Votes', readonly=True),
     }
+
     def init(self, cr):
         """
         initialize the sql view for the stats
@@ -180,19 +339,19 @@ class idea_vote_stat(osv.osv):
         cr -- the cursor
         """
         cr.execute("""
-            create or replace view idea_vote_stat as (
-                select
-                    min(v.id) as id,
-                    i.id as idea_id,
+            CREATE OR REPLACE VIEW idea_vote_stat AS (
+                SELECT
+                    MIN(v.id) AS id,
+                    i.id AS idea_id,
                     v.score,
-                    count(1) as nbr
-                from
+                    COUNT(1) AS nbr
+                FROM
                     idea_vote v
-                    left join
-                    idea_idea i on (v.idea_id=i.id)
-                group by
-                    i.id, v.score, i.id
-        )""")
+                    LEFT JOIN idea_idea i ON (v.idea_id = i.id)
+                GROUP BY
+                    i.id, v.score, i.id )
+        """)
+
 idea_vote_stat()
 
 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: