odoo/addons/survey/survey.py

# -*- encoding: utf-8 -*-
##############################################################################
#
#    OpenERP, Open Source Management Solution
#    Copyright (C) 2004-TODAY OpenERP S.A. <http: //www.openerp.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 Affero 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 urllib import urlencode
from urlparse import urljoin
from openerp.osv import fields, osv
from openerp.tools.translate import _
import uuid


class survey_survey(osv.osv):
    '''Settings for a multi-page/multi-question survey.
    Each survey can have one or more attached pages, and each page can present
    one or more questions.
    '''

    _name = 'survey.survey'
    _description = 'Survey'
    _rec_name = 'title'
    _inherit = ['mail.thread', 'ir.needaction_mixin']

    # Protected methods #

    def _empty_check(self, cr, uid, ids, context=None):
        """ Ensure that this survey has at least one page with at least one
        question. If not, raises an exception. """
        for survey in self.browse(cr, uid, ids, context=context):
            if not survey.page_ids or not [page.question_ids
                            for page in survey.page_ids if page.question_ids]:
                raise osv.except_osv(_('Warning!'),
                    _('This survey has no question defined or has no pages \
                        defined.'))

    ## Function fields ##

    def _get_tot_start_survey(self, cr, uid, ids, name, arg, context=None):
        """ Returns the number of started instances of this survey, be they
        completed or not """
        res = dict((id, 0) for id in ids)
        sur_res_obj = self.pool.get('survey.user_input')
        for id in ids:
            res[id] = sur_res_obj.search(cr, uid,  # SUPERUSER_ID,
                [('survey_id', '=', id), ('state', '=', 'skip')],
                context=context, count=True)
        return res

    def _get_tot_comp_survey(self, cr, uid, ids, name, arg, context=None):
        """ Returns the number of completed instances of this survey """
        res = dict((id, 0) for id in ids)
        sur_res_obj = self.pool.get('survey.user_input')
        for id in ids:
            res[id] = sur_res_obj.search(cr, uid,  # SUPERUSER_ID,
                [('survey_id', '=', id), ('state', '=', 'done')],
                context=context, count=True)
        return res

    def _get_public_url(self, cr, uid, ids, name, arg, context=None):
        """ Computes a public URL for the survey """
        res = dict((id, 0) for id in ids)
        base_url = self.pool.get('ir.config_parameter').get_param(cr, uid,
            'web.base.url')
        for survey_browse in self.browse(cr, uid, ids, context=context):
            query = {
                'db': cr.dbname
            }
            fragment = {
                #'survey_id': survey_browse.id,
                'action': 'survey.action_filling',
                'survey_token': survey_browse.token,
            }
            res[survey_browse.id] = urljoin(base_url, "?%s#%s"
                                    % (urlencode(query), urlencode(fragment)))
        return res

    # Model fields #

    _columns = {
        'title': fields.char('Title', size=128, required=1,
            translate=True),
        'category': fields.char('Category', size=128),
        'page_ids': fields.one2many('survey.page', 'survey_id', 'Pages'),
        'date_open': fields.datetime('Opening date'),
        'date_close': fields.datetime('Closing date'),
        'user_input_limit': fields.integer('Automatic closing limit',
            help="Limits the number of instances of this survey that can be \
            completed (if set to 0, no limit is applied",
            oldname='max_response_limit'),
        'state': fields.selection(
            [('draft', 'Draft'), ('open', 'Open'), ('close', 'Closed'),
            ('cancel', 'Cancelled')], 'Status', required=1, readonly=1,
            translate=1),
        'visible_to_user': fields.boolean('Visible in the Surveys menu'),
        'auth_required': fields.boolean('Login required',
            help="Users with a public link will be requested to login before \
            takin part to the survey", oldname="authenticate"),
        'tot_start_survey': fields.function(_get_tot_start_survey,
            string="Number of started surveys", type="integer"),
        'tot_comp_survey': fields.function(_get_tot_comp_survey,
            string="Number of completed surveys", type="integer"),
        'description': fields.text('Description', size=128, translate=True,
            oldname="description"),
        'color': fields.integer('Color Index'),
        'user_input_ids': fields.one2many('survey.user_input', 'survey_id',
            'User responses', readonly=1,),
        'public_url': fields.function(_get_public_url,
            string="Public link", type="char", store=True),
        'token': fields.char('Public token', size=36, required=True,
            readonly=True,),
        'email_template_id': fields.many2one('email.template',
            'Email Template', ondelete='set null'),
    }
    _defaults = {
        'category': 'Uncategorized',
        'user_input_limit': 0,
        'state': 'draft',
        'visible_to_user': True,
        'auth_required': True,
        'token': lambda s, cr, uid, c: uuid.uuid4().__str__(),
    }

    # Public methods #

    ## Workflow transitions ##

    def survey_draft(self, cr, uid, ids, arg):
        return self.write(cr, uid, ids, {'state': 'draft', 'date_open': None})

    def survey_open(self, cr, uid, ids, arg):
        return self.write(cr, uid, ids, {'state': 'open',
            'date_open': fields.datetime.now})

    def survey_close(self, cr, uid, ids, arg):
        return self.write(cr, uid, ids, {'state': 'close',
            'date_close': fields.datetime.now})

    def survey_cancel(self, cr, uid, ids, arg):
        return self.write(cr, uid, ids, {'state': 'cancel',
            'date_close': fields.datetime.now})

    ## Actions ##

    def copy(self, cr, uid, ids, default=None, context=None):
        vals = {}
        current_rec = self.read(cr, uid, ids, context=context)
        title = _("%s (copy)") % (current_rec.get('title'))
        vals['title'] = title
        return super(survey_survey, self).copy(cr, uid, ids, vals,
            context=context)

    def action_print_survey_questions(self, cr, uid, ids, context=None):
        ''' Generates a printable view of an empty survey '''
        pass

    def action_print_survey_user_inputs(self, cr, uid, ids, context=None):
        ''' Generates printable views of answered surveys '''
        pass

    def action_print_survey_statistics(self, cr, uid, ids, context=None):
        ''' Generates a printable view of the survey results '''
        pass

    def action_fill_survey(self, cr, uid, ids, context=None):
        ''' Open a survey in filling view '''
        id = ids[0]
        survey = self.browse(cr, uid, id, context=context)
        context.update({'edit': False, 'survey_id': id,
            'survey_token': survey.token,
            'ir_actions_act_window_target': 'inline'})
        return {
            'view_type': 'form',
            'view_mode': 'form',
            'res_model': 'survey.question.wiz',
            'type': 'ir.actions.act_window',
            'target': 'inline',
            'name': survey.title,
            'context': context
        }

    def action_test_survey(self, cr, uid, ids, context=None):
        ''' Open a survey in filling view '''
        context.update({'survey_test': True})
        return self.action_fill_survey(cr, uid, ids, context=context)

    def action_edit_survey(self, cr, uid, ids, context=None):
        ''' Open a survey in edition view '''
        id = ids[0]
        context.update({
            'survey_id': id,
            'edit': True,
            'ir_actions_act_window_target': 'new',
        })
        return {
            'view_type': 'form',
            'view_mode': 'form',
            'res_model': 'survey.question.wiz',
            'type': 'ir.actions.act_window',
            'target': 'new',
            'name': self.browse(cr, uid, id, context=context).title,
            'context': context
        }

    def action_send_survey(self, cr, uid, ids, context=None):
        ''' Open a window to compose an email, pre-filled with the survey
        message '''
        self._empty_check(cr, uid, ids, context=context)

        survey_browse = self.pool.get('survey.survey').browse(cr, uid, ids,
            context=context)[0]
        if survey_browse.state != "open":
            raise osv.except_osv(_('Warning!'),
                _("You cannot send invitations since the survey is not open."))

        assert len(ids) == 1, 'This option should only be used for a single \
                                survey at a time.'
        ir_model_data = self.pool.get('ir.model.data')
        try:
            template_id = ir_model_data.get_object_reference(cr, uid,
                                'survey.survey', 'email_template_survey')[1]
        except ValueError:
            template_id = False
        ctx = dict(context)

        ctx.update({
            'default_model': 'survey.survey',
            'default_res_id': ids[0],
            'default_survey_id': ids[0],
            'default_use_template': bool(template_id),
            'default_template_id': template_id,
            'default_composition_mode': 'comment',
            'survey_state': survey_browse.state
            })
        return {
            'type': 'ir.actions.act_window',
            'view_type': 'form',
            'view_mode': 'form',
            'res_model': 'survey.mail.compose.message',
            'target': 'new',
            'context': ctx,
        }

    # def unlink(self, cr, uid, ids, context=None):
    #     ''' Delete survey and linked email templates (if any) '''
    #     email_template_ids = list()
    #     for survey in self.browse(cr, uid, ids, context=context):
    #         email_template_ids.append(survey.email_template_id.id)
    #     if email_template_ids:
    #         self.pool.get('email.template').unlink(cr, uid, email_template_ids,
    #                                             context=context)
    #     return super(survey_survey, self).unlink(cr, uid, ids, context=context)


class survey_page(osv.osv):
    '''A page for a survey.

    Pages are essentially containers, allowing to group questions by ordered
    screens.

    .. note::
        A page should be deleted if the survey it belongs to is deleted. '''

    _name = 'survey.page'
    _description = 'Survey Page'
    _rec_name = 'title'
    _order = 'sequence'

    # Model Fields #

    _columns = {
        'title': fields.char('Page Title', size=128, required=1,
            translate=True),
        'survey_id': fields.many2one('survey.survey', 'Survey',
            ondelete='cascade'),
        'question_ids': fields.one2many('survey.question', 'page_id',
            'Questions'),
        'sequence': fields.integer('Page number'),
        'description': fields.text('Description',
            help="An introductory text to your page", translate=True,
            oldname="note"),
    }
    _defaults = {
        'sequence': 1
    }

    # Public methods #

    def survey_save(self, cr, uid, ids, context=None):
        if context is None:
            context = {}
        surv_name_wiz = self.pool.get('survey.question.wiz')
        surv_name_wiz.write(cr, uid, [context.get('wizard_id', False)],
            {'transfer': True, 'page_no': context.get('page_number', 0)})
        return {
            'view_type': 'form',
            'view_mode': 'form',
            'res_model': 'survey.question.wiz',
            'type': 'ir.actions.act_window',
            'target': 'new',
            'context': context
        }

    def copy(self, cr, uid, ids, default=None, context=None):
        vals = {}
        current_rec = self.read(cr, uid, ids, context=context)
        title = _("%s (copy)") % (current_rec.get('title'))
        vals.update({'title': title})
        return super(survey_page, self).copy(cr, uid, ids, vals,
            context=context)


class survey_question(osv.osv):
    ''' Questions that will be asked in a survey.

    Each question can have one of more suggested answers (eg. in case of
    dropdown choices, multi-answer checkboxes, radio buttons...)

    Changes
    -------

    This version of the model has been simplified in relation to the previous
    one: some fields were simply a n-time repetition of a simpler field. It is
    now allowed to have children question that allows to group subquestions.'''
    _name = 'survey.question'
    _description = 'Question'
    _rec_name = 'question'
    _order = 'sequence'

    # Model fields #

    _columns = {
        # Question metadata
        'page_id': fields.many2one('survey.page', 'Survey page',
            ondelete='cascade'),
        'survey_id': fields.related('page_id', 'survey_id', type='many2one',
            relation='survey.survey', string='Survey', store=True),
        'parent_id': fields.many2one('survey.question', 'Parent question'),
        'children_ids': fields.one2many('survey.question', 'parent_id',
            'Children questions'),
        'sequence': fields.integer('Sequence'),

        # Question
        'question': fields.char('Question', required=1, translate=True),
        'description': fields.text('Description', help="Use this field to add \
            additional explanations about your question", translate=True,
            oldname='descriptive_text'),
        'display': fields.selection(
            [('horizontal', 'Horizontal'),
            ('vertical', 'Vertical')],
            'Display'),

        # Answer
        'type': fields.selection([('textbox', 'Text box'),
                ('numerical_box', 'Numerical box'),
                ('free_text', 'Free Text'),
                ('datetime', 'Date and Time'),
                ('checkbox', 'Checkbox'),
                ('simple_choice_scale', 'One choice on a scale'),
                ('simple_choice_dropdown', 'One choice in a menu'),
                ('multiple_choice', 'Some choices in checkboxes'),
                ('vector', 'Container of questions'),
                ('matrix', 'Container of containers of questions')
            ], 'Question Type', required=1),

        'suggested_answers_ids': fields.one2many('survey.suggestion',
            'question_id', 'Suggested answers', oldname='answer_choice_ids'),

        # Comments
        'comments_allowed': fields.boolean('Allow comments',
            oldname="allow_comment"),
        'comment_children_ids': fields.one2many('survey.question_id',
            'parent_id', 'Comment question'),  # one2one in fact
        'comment_count_as_answer': fields.boolean('Make Comment Field an \
            Answer Choice', oldname='make_comment_field'),

        # Validation
        'validation_required': fields.boolean('Validate entry',
            oldname='is_validation_require'),
        'validation_type': fields.selection([
            ('none', '''Don't validate'''),
            ('has_length', 'Must Be Specific Length'),
            ('is_integer', 'Must Be A Whole Number'),
            ('is_decimal', 'Must Be A Decimal Number'),
            ('is_date', 'Must Be A Date'),
            ('is_email', 'Must Be An Email Address')
            ], 'Text Validation'),
        'validation_length': fields.integer('Specific length'),
        'validation_min_value': fields.float('Minimum value'),
        'validation_max_value': fields.float('Maximum value'),
        'validation_min_date': fields.date('Start date range'),
        'validation_max_date': fields.date('End date range'),
        'validation_error_msg': fields.char("Error message if validation \
            fails", oldname='validation_valid_err_msg'),

        'numeric_required_sum': fields.integer('Sum of all choices'),
        'numeric_required_sum_err_msg': fields.text('Error message',
            translate=True),

        # 'in_visible_rating_weight': fields.boolean('Is Rating Scale nvisible?'),
        # 'in_visible_menu_choice': fields.boolean('Is Menu Choice Invisible?'),
        # 'in_visible_answer_type': fields.boolean('Is Answer Type Invisible?'),
        # 'comment_column': fields.boolean('Add comment column in matrix'),
        # 'column_name': fields.char('Column Name', translate=True),
        # 'no_of_rows': fields.integer('No of Rows'),

        # Constraints on number of answers
        'constr_mandatory': fields.boolean('Mandatory question',
            oldname="is_require_answer"),
        'constr_type': fields.selection([('all', 'All'),
            ('at least', 'At Least'),
            ('at most', 'At Most'),
            ('exactly', 'Exactly'),
            ('a range', 'A Range')],
            'Constraint on answers number', oldname='required_type'),
        'constr_maximum_req_ans': fields.integer('Maximum Required Answer',
            oldname='maximum_req_ans'),
        'constr_minimum_req_ans': fields.integer('Minimum Required Answer',
            oldname='minimum_req_ans'),
        'constr_error_msg': fields.char("Error message if constraints fails",
            oldname='req_error_msg'),
    }
    _defaults = {
        'sequence': 1,
        'page_id': lambda s, cr, uid, c: c.get('page_id'),
        'type': lambda s, cr, uid, c: _('multiple_choice'),
        #'req_error_msg': lambda s, cr, uid, c: _('This question requires an answer.'),
        'constr_type': 'at least',
        'constr_minimum_req_ans': 1,
        #'comment_field_type': 'char',
        #'comment_label': lambda s, cr, uid, c: _('Other (please specify)'),
        #'comment_valid_type': 'do_not_validate',
        #'comment_valid_err_msg': lambda s, cr, uid, c: _('The comment you entered is in an invalid format.'),
        'validation_type': 'do_not_validate',
        #'validation_valid_err_msg': lambda s, cr, uid, c: _('The comment you entered is in an invalid format.'),
        #'numeric_required_sum_err_msg': lambda s, cr, uid, c: _('The choices need to add up to [enter sum here].'),
        #'make_comment_field_err_msg': lambda s, cr, uid, c: _('Please enter a comment.'),
        #'in_visible_answer_type': 1
    }

    def on_change_type(self, cr, uid, ids, type, context=None):
        ''' Updates the editing view in relation with the question type '''
        val = {}
        val['is_require_answer'] = False
        val['is_comment_require'] = False
        val['is_validation_require'] = False
        val['comment_column'] = False

        if type in ['multiple_textboxes_diff_type']:
            val['in_visible_answer_type'] = False
            return {'value': val}

        if type in ['rating_scale']:
            val.update({'in_visible_rating_weight': False,
                        'in_visible_menu_choice': True})
            return {'value': val}

        elif type in ['single_textbox']:
            val.update({'in_visible_rating_weight': True,
                        'in_visible_menu_choice': True})
            return {'value': val}

        else:
            val.update({'in_visible_rating_weight': True,
                        'in_visible_menu_choice': True,
                        'in_visible_answer_type': True})
            return {'value': val}

    def on_change_page_id(self, cr, uid, ids, page_id, context=None):
        if page_id:
            page = self.pool.get('survey.page').browse(cr, uid, page_id,
                                    context=context)
            return {'survey_id': page.survey_id and page.survey_id.id}
        return {'value': {}}

    def write(self, cr, uid, ids, vals, context=None):
        questions = self.read(cr, uid, ids, ['answer_choice_ids', 'type',
            'required_type', 'req_ans', 'minimum_req_ans', 'maximum_req_ans',
            'column_heading_ids', 'page_id', 'question'])
        for question in questions:
            col_len = len(question['column_heading_ids'])
            for col in vals.get('column_heading_ids', []):
                if type(col[2]) == type({}):
                    col_len += 1
                else:
                    col_len -= 1

            que_type = vals.get('type', question['type'])

            if que_type in ['matrix_of_choices_only_one_ans', 'matrix_of_choices_only_multi_ans', 'rating_scale']:
                if not col_len:
                    raise osv.except_osv(_('Warning!'), _('You must enter one or more column headings for question "%s" of page %s.') % (question['question'], question['page_id'][1]))
            ans_len = len(question['answer_choice_ids'])

            for ans in vals.get('answer_choice_ids', []):
                if type(ans[2]) == type({}):
                    ans_len += 1
                else:
                    ans_len -= 1

            if que_type not in ['descriptive_text', 'single_textbox', 'comment', 'table']:
                if not ans_len:
                    raise osv.except_osv(_('Warning!'), _('You must enter one or more Answers for question "%s" of page %s.') % (question['question'], question['page_id'][1]))

            req_type = vals.get('required_type', question['required_type'])

            if que_type in ['multiple_choice_multiple_ans', 'matrix_of_choices_only_one_ans', \
                        'matrix_of_choices_only_multi_ans', 'rating_scale', 'multiple_textboxes', \
                        'numerical_textboxes', 'date', 'date_and_time']:
                if req_type in ['at least', 'at most', 'exactly']:
                    if 'req_ans' in vals:
                        if not vals['req_ans'] or vals['req_ans'] > ans_len:
                            raise osv.except_osv(_('Warning!'), _("#Required Answer you entered \
                                    is greater than the number of answer. \
                                    Please use a number that is smaller than %d.") % (ans_len + 1))
                    else:
                        if not question['req_ans'] or question['req_ans'] > ans_len:
                            raise osv.except_osv(_('Warning!'), _("#Required Answer you entered is \
                                    greater than the number of answer.\
                                    Please use a number that is smaller than %d.") % (ans_len + 1))

                if req_type == 'a range':
                    minimum_ans = 0
                    maximum_ans = 0
                    minimum_ans = 'minimum_req_ans' in vals and vals['minimum_req_ans'] or question['minimum_req_ans']
                    maximum_ans = 'maximum_req_ans' in vals and vals['maximum_req_ans'] or question['maximum_req_ans']

                    if not minimum_ans or minimum_ans > ans_len or not maximum_ans or maximum_ans > ans_len:
                        raise osv.except_osv(_('Warning!'), _("Minimum Required Answer you\
                                 entered is greater than the number of answer. \
                                 Please use a number that is smaller than %d.") % (ans_len + 1))
                    if maximum_ans <= minimum_ans:
                        raise osv.except_osv(_('Warning!'), _("Maximum Required Answer is greater \
                                    than Minimum Required Answer"))

        return super(survey_question, self).write(cr, uid, ids, vals, context=context)

    def create(self, cr, uid, vals, context=None):
        page = self.pool.get('survey.page').browse(cr, uid, 'page_id' in vals and vals['page_id'] or context['page_id'], context=context)
        if 'answer_choice_ids' in vals and not len(vals.get('answer_choice_ids', [])) and \
            vals.get('type') not in ['descriptive_text', 'single_textbox', 'comment', 'table']:
            raise osv.except_osv(_('Warning!'), _('You must enter one or more answers for question "%s" of page %s .') % (vals['question'], page.title))

        if 'column_heading_ids' in vals and not len(vals.get('column_heading_ids', [])) and \
            vals.get('type') in ['matrix_of_choices_only_one_ans', 'matrix_of_choices_only_multi_ans', 'rating_scale']:
            raise osv.except_osv(_('Warning!'), _('You must enter one or more column headings for question "%s" of page %s.') % (vals['question'], page.title))

        if 'is_require_answer' in vals and vals.get('type') in ['multiple_choice_multiple_ans', 'matrix_of_choices_only_one_ans', \
            'matrix_of_choices_only_multi_ans', 'rating_scale', 'multiple_textboxes', 'numerical_textboxes', 'date', 'date_and_time']:
            if vals.get('required_type') in ['at least', 'at most', 'exactly']:
                if 'answer_choice_ids' in vals and 'answer_choice_ids' in vals and vals.get('req_ans') > len(vals.get('answer_choice_ids', [])):
                    raise osv.except_osv(_('Warning!'), _("#Required Answer you entered is greater than the number of answer. Please use a number that is smaller than %d.") % (len(vals['answer_choice_ids']) + 1))
            if vals.get('required_type') == 'a range':
                if 'answer_choice_ids' in vals:
                    if not vals.get('minimum_req_ans') or vals['minimum_req_ans'] > len(vals['answer_choice_ids']):
                        raise osv.except_osv(_('Warning!'), _("Minimum Required Answer you entered is greater than the number of answer. Please use a number that is smaller than %d.") % (len(vals['answer_choice_ids']) + 1))
                    if not vals.get('maximum_req_ans') or vals['maximum_req_ans'] > len(vals['answer_choice_ids']):
                        raise osv.except_osv(_('Warning!'), _("Maximum Required Answer you entered for your maximum is greater than the number of answer. Please use a number that is smaller than %d.") % (len(vals['answer_choice_ids']) + 1))
                if vals.get('maximum_req_ans', 0) <= vals.get('minimum_req_ans', 0):
                    raise osv.except_osv(_('Warning!'), _("Maximum Required Answer is greater than Minimum Required Answer."))

        return super(survey_question, self).create(cr, uid, vals, context)

    def survey_save(self, cr, uid, ids, context=None):
        if context is None:
            context = {}
        surv_name_wiz = self.pool.get('survey.question.wiz')
        surv_name_wiz.write(cr, uid, [context.get('wizard_id', False)],
            {'transfer': True, 'page_no': context.get('page_number', False)})
        return {
            'view_type': 'form',
            'view_mode': 'form',
            'res_model': 'survey.question.wiz',
            'type': 'ir.actions.act_window',
            'target': 'new',
            'context': context
        }


class survey_suggestion(osv.osv):
    ''' A suggested answer for a question '''
    _name = 'survey.suggestion'
    _rec_name = 'value'

    _columns = {
        #'survey_id': fields.related('page_id', 'survey_id', type='many2one',
        #    relation='survey.survey', string='Survey', store=True),
        'question_id': fields.many2one('survey.question', 'Question',
            required=True, ondelete='cascade'),
        'value': fields.char("Suggested value", length=128, translate=True,
            required=True)
    }


class survey_user_input(osv.osv):
    ''' Metadata for a set of one user's answers to a particular survey '''
    _name = "survey.user_input"
    _rec_name = 'date_create'

    _columns = {
        'survey_id': fields.many2one('survey.survey', 'Survey', required=True,
            readonly=1, ondelete='restrict'),
        'date_create': fields.datetime('Creation Date', required=True,
            readonly=1),
        'deadline': fields.date("Deadline",
            help="Date by which the person can take part to the survey",
            oldname="date_deadline"),
        'type': fields.selection([('manually', 'Manually'), ('link', 'Link')],
            'Answer Type', required=1, oldname="response_type"),
        'state': fields.selection([('new', 'Not started yet'),
            ('skip', 'Partially completed'),
            ('done', 'Completed'),
            ('cancel', 'Cancelled'),
            ('test', 'Test')], 'Status',
            readonly=True),

        # Optional Identification data
        'token': fields.char("Indentification token", readonly=1, size=36),
        'partner_id': fields.many2one('res.partner', 'Partner', readonly=1),
        'email': fields.char("E-mail", size=64, readonly=1),

        # The answers !
        'user_input_line_ids': fields.one2many('survey.user_input.line',
            'user_input_id', 'Answers'),
    }
    _defaults = {
        'date_create': fields.datetime.now,
        'type': 'manually',
        'state': 'new',
        'token': lambda s, cr, uid, c: uuid.uuid4().__str__(),
    }

    def action_survey_resent(self, cr, uid, ids, context=None):
        record = self.browse(cr, uid, ids[0], context=context)
        context = context or {}
        context.update({
            'survey_resent_token': True,
            'default_partner_ids': record.partner_id and [record.partner_id.id] or [],
            'default_multi_email': record.email or "",
            'default_public': 'email_private',
        })
        return self.pool.get('survey.survey').action_survey_sent(cr, uid,
            [record.survey_id.id], context=context)

    def action_print_response(self, cr, uid, ids, context=None):
        """
        Print Survey Answer in pdf format.
        @return : Dictionary value for created survey answer report
        """
        return {
            'type': 'ir.actions.report.xml',
            'report_name': 'survey.browse.response',
            'datas': {
                'model': 'survey.print.statistics',
                'form': {
                    'response_ids': ids,
                    'orientation': 'vertical',
                    'paper_size': 'letter',
                    'page_number': 0,
                    'without_pagebreak': 0
                    }
                },
            }

    def action_preview(self, cr, uid, ids, context=None):
        """
        Get preview response
        """
        context = context or {}
        self.pool.get('survey.survey').check_access_rights(cr, uid, 'write')

        record = self.browse(cr, uid, ids[0], context=context)
        context.update({
            'ir_actions_act_window_target': 'new',
            'survey_id': record.survey_id.id,
            'response_id': ids[0],
            'readonly': True,
        })
        return {
            'view_type': 'form',
            "view_mode": 'form',
            'res_model': 'survey.question.wiz',
            'type': 'ir.actions.act_window',
            'target': 'new',
            'context': context
        }

    def action_cancel(self, cr, uid, ids, context=None):
        self.pool.get('survey.survey').check_access_rights(cr, uid, 'write')
        return self.write(cr, uid, ids, {'state': 'cancel'})

    def name_get(self, cr, uid, ids, context=None):
        if not len(ids):
            return []
        reads = self.read(cr, uid, ids, ['partner_id', 'date_create'],
            context=context)
        res = []
        for record in reads:
            name = (record['partner_id'] and record['partner_id'][1] or '') + ' (' + record['date_create'].split('.')[0] + ')'
            res.append((record['id'], name))
        return res

    def copy(self, cr, uid, id, default=None, context=None):
        raise osv.except_osv(_('Warning!'), _('You cannot duplicate this \
            element!'))


class survey_user_input_line(osv.osv):
    _name = 'survey.user_input.line'
    _description = 'User input line'
    _rec_name = 'date_create'
    _columns = {
        'survey_id': fields.many2one('survey.survey', 'Survey', required=1,
            readonly=1, ondelete='cascade'),
        'user_input_id': fields.many2one('survey.user_input', 'User Input',
            ondelete='cascade', required=1),
        'date_create': fields.datetime('Create Date', required=1),  # drop
        'skipped': fields.boolean('Skipped'),
        'question_id': fields.many2one('survey.question', 'Question',
            ondelete='restrict'),
        'answer_type': fields.selection([('textbox', 'Text box'),
                ('numerical_box', 'Numerical box'),
                ('free_text', 'Free Text'),
                ('datetime', 'Date and Time'),
                ('checkbox', 'Checkbox'),
            ], 'Question Type', required=1),
        'value_text': fields.char("Text answer"),
        'value_number': fields.float("Numerical answer"),
        'value_date': fields.datetime("Date answer"),
        'value_free_text': fields.text("Free Text answer"),
        'value_suggested': fields.many2one('survey.suggestion'),
    }
    _defaults = {
        'skipped': False,
        'date_create': fields.datetime.now
    }

# vim: exp and tab: smartindent: tabstop=4: softtabstop=4: shiftwidth=4: