app/soc/views/models/timeline.py
author Madhusudan.C.S <madhusudancs@gmail.com>
Mon, 24 Aug 2009 04:31:23 +0530
changeset 2787 8408741aee63
parent 2784 801eee4eda9a
child 2810 e63b3e0845a9
permissions -rw-r--r--
Reverting last 4 patches containing GHOP related views. As Lennard suggested all the model patches should come first followed by the logic and views patches, to make sure nothing committed breaks the existing code after thorough review.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
768
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     1
#!/usr/bin/python2.5
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     2
#
1307
091a21cf3627 Update the copyright notice for 2009.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1108
diff changeset
     3
# Copyright 2009 the Melange authors.
768
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     4
#
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     5
# Licensed under the Apache License, Version 2.0 (the "License");
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     6
# you may not use this file except in compliance with the License.
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     7
# You may obtain a copy of the License at
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     8
#
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     9
#   http://www.apache.org/licenses/LICENSE-2.0
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    10
#
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    11
# Unless required by applicable law or agreed to in writing, software
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    12
# distributed under the License is distributed on an "AS IS" BASIS,
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    13
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    14
# See the License for the specific language governing permissions and
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    15
# limitations under the License.
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    16
847
b1077116fe59 Add calendar widget support for timeline fields. Fix docstring typo in soc.views.models.timeline module. Add timeline edit template which loads necessary javascript files for datetimepicker widget.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 799
diff changeset
    17
"""Views for Timeline.
768
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    18
"""
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    19
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    20
__authors__ = [
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    21
    '"Sverre Rabbelier" <sverre@rabbelier.nl>',
847
b1077116fe59 Add calendar widget support for timeline fields. Fix docstring typo in soc.views.models.timeline module. Add timeline edit template which loads necessary javascript files for datetimepicker widget.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 799
diff changeset
    22
    '"Pawel Solyga" <pawel.solyga@gmail.com>',
768
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    23
  ]
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    24
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    25
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    26
from django import forms
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    27
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    28
from soc.logic import dicts
778
bc13cd968946 Added support for mutliple edit forms based on entity type
Sverre Rabbelier <srabbelier@gmail.com>
parents: 776
diff changeset
    29
from soc.logic.models import program as program_logic
1108
64acc3c02ad1 Added rights to soc/views/models/timeline.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 949
diff changeset
    30
from soc.views.helper import access
1583
1e4c785f1adf Added decorators
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1475
diff changeset
    31
from soc.views.helper import decorators
949
07fdadbd6dc7 Check if timeline exists and when somebody tries to edit non existing timelime display error message. Add TODO regarding error message customization for Timeline. Add support for calendar widget in timeline for both gsoc and ghop programs (gsoc was hardcoded before).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 858
diff changeset
    32
from soc.views.helper import dynaform
778
bc13cd968946 Added support for mutliple edit forms based on entity type
Sverre Rabbelier <srabbelier@gmail.com>
parents: 776
diff changeset
    33
from soc.views.helper import params as params_helper
768
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    34
from soc.views.models import base
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    35
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    36
import soc.logic.models.timeline
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    37
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    38
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    39
class View(base.View):
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    40
  """View methods for the Timeline model.
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    41
  """
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    42
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    43
  def __init__(self, params=None):
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    44
    """Defines the fields and methods required for the base View class
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    45
    to provide the user with list, public, create, edit and delete views.
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    46
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    47
    Params:
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    48
      params: a dict with params for this View
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    49
    """
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    50
1108
64acc3c02ad1 Added rights to soc/views/models/timeline.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 949
diff changeset
    51
    rights = access.Checker(params)
64acc3c02ad1 Added rights to soc/views/models/timeline.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 949
diff changeset
    52
    rights['edit'] = ['checkCanEditTimeline']
64acc3c02ad1 Added rights to soc/views/models/timeline.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 949
diff changeset
    53
768
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    54
    new_params = {}
1108
64acc3c02ad1 Added rights to soc/views/models/timeline.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 949
diff changeset
    55
    new_params['rights'] = rights
768
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    56
    new_params['logic'] = soc.logic.models.timeline.logic
847
b1077116fe59 Add calendar widget support for timeline fields. Fix docstring typo in soc.views.models.timeline module. Add timeline edit template which loads necessary javascript files for datetimepicker widget.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 799
diff changeset
    57
    new_params['edit_template'] = 'soc/timeline/edit.html'
768
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    58
    new_params['name'] = "Timeline"
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    59
776
f86a76f52bf4 Started on edit timeline
Sverre Rabbelier <srabbelier@gmail.com>
parents: 768
diff changeset
    60
    patterns = [(r'^%(url_name)s/(?P<access_type>edit)/%(key_fields)s$',
2787
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
    61
                  'soc.views.models.%(module_name)s.edit', 
847
b1077116fe59 Add calendar widget support for timeline fields. Fix docstring typo in soc.views.models.timeline module. Add timeline edit template which loads necessary javascript files for datetimepicker widget.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 799
diff changeset
    62
                  "Edit %(name_short)s")]
776
f86a76f52bf4 Started on edit timeline
Sverre Rabbelier <srabbelier@gmail.com>
parents: 768
diff changeset
    63
1475
22b63ab59b27 Make timeline a Linkable
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1451
diff changeset
    64
    new_params['create_extra_dynaproperties'] = {
22b63ab59b27 Make timeline a Linkable
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1451
diff changeset
    65
        'link_id': forms.CharField(widget=forms.HiddenInput)
22b63ab59b27 Make timeline a Linkable
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1451
diff changeset
    66
        }
776
f86a76f52bf4 Started on edit timeline
Sverre Rabbelier <srabbelier@gmail.com>
parents: 768
diff changeset
    67
    new_params['django_patterns_defaults'] = patterns
f86a76f52bf4 Started on edit timeline
Sverre Rabbelier <srabbelier@gmail.com>
parents: 768
diff changeset
    68
1430
ff8cc6b15e6a Rename dynafields to dynaproperties
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1343
diff changeset
    69
    new_params['edit_dynaproperties'] = []
847
b1077116fe59 Add calendar widget support for timeline fields. Fix docstring typo in soc.views.models.timeline module. Add timeline edit template which loads necessary javascript files for datetimepicker widget.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 799
diff changeset
    70
768
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    71
    params = dicts.merge(params, new_params)
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    72
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    73
    super(View, self).__init__(params=params)
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    74
2787
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
    75
    for name, logic_value in program_logic.logic.TIMELINE_LOGIC.iteritems():
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
    76
      create_form = params_helper.getCreateForm(self._params, 
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
    77
          logic_value.getModel())
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
    78
      edit_form = dynaform.extendDynaForm(
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
    79
        dynaform = create_form,
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
    80
        dynainclude = self._params['edit_dynainclude'],
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
    81
        dynaexclude = self._params['edit_dynaexclude'],
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
    82
        )
1451
ef134d062b83 Add generic datepicker support
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1430
diff changeset
    83
2787
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
    84
      self._params['edit_form_%s' % name] = edit_form
778
bc13cd968946 Added support for mutliple edit forms based on entity type
Sverre Rabbelier <srabbelier@gmail.com>
parents: 776
diff changeset
    85
bc13cd968946 Added support for mutliple edit forms based on entity type
Sverre Rabbelier <srabbelier@gmail.com>
parents: 776
diff changeset
    86
  def edit(self, request, access_type,
bc13cd968946 Added support for mutliple edit forms based on entity type
Sverre Rabbelier <srabbelier@gmail.com>
parents: 776
diff changeset
    87
           page_name=None, params=None, seed=None, **kwargs):
784
23eaf3aa19b1 Fix missing dots at the end of sentences in docstring and fix wrong import sorting in soc.logic.helper.notifications module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 778
diff changeset
    88
    """See base.View.edit.
778
bc13cd968946 Added support for mutliple edit forms based on entity type
Sverre Rabbelier <srabbelier@gmail.com>
parents: 776
diff changeset
    89
    """
1785
d7c5112b1d44 Use the correct timeline logic in edit()
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1636
diff changeset
    90
778
bc13cd968946 Added support for mutliple edit forms based on entity type
Sverre Rabbelier <srabbelier@gmail.com>
parents: 776
diff changeset
    91
    params = dicts.merge(params, self._params)
1785
d7c5112b1d44 Use the correct timeline logic in edit()
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1636
diff changeset
    92
949
07fdadbd6dc7 Check if timeline exists and when somebody tries to edit non existing timelime display error message. Add TODO regarding error message customization for Timeline. Add support for calendar widget in timeline for both gsoc and ghop programs (gsoc was hardcoded before).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 858
diff changeset
    93
    # TODO(pawel.solyga): If program doesn't exist for timeline display
07fdadbd6dc7 Check if timeline exists and when somebody tries to edit non existing timelime display error message. Add TODO regarding error message customization for Timeline. Add support for calendar widget in timeline for both gsoc and ghop programs (gsoc was hardcoded before).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 858
diff changeset
    94
    # customized error message without pointing to 'Create Timeline'
1475
22b63ab59b27 Make timeline a Linkable
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1451
diff changeset
    95
22b63ab59b27 Make timeline a Linkable
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1451
diff changeset
    96
    key_fields = program_logic.logic.getKeyFieldsFromFields(kwargs)
22b63ab59b27 Make timeline a Linkable
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1451
diff changeset
    97
22b63ab59b27 Make timeline a Linkable
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1451
diff changeset
    98
    program = program_logic.logic.getFromKeyFields(key_fields)
949
07fdadbd6dc7 Check if timeline exists and when somebody tries to edit non existing timelime display error message. Add TODO regarding error message customization for Timeline. Add support for calendar widget in timeline for both gsoc and ghop programs (gsoc was hardcoded before).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 858
diff changeset
    99
    if program:
2787
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
   100
      workflow = program.workflow
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
   101
      params['edit_form'] = params["edit_form_%s" % workflow]
8408741aee63 Reverting last 4 patches containing GHOP related views.
Madhusudan.C.S <madhusudancs@gmail.com>
parents: 2784
diff changeset
   102
      params['logic'] = program_logic.logic.TIMELINE_LOGIC[workflow]
778
bc13cd968946 Added support for mutliple edit forms based on entity type
Sverre Rabbelier <srabbelier@gmail.com>
parents: 776
diff changeset
   103
bc13cd968946 Added support for mutliple edit forms based on entity type
Sverre Rabbelier <srabbelier@gmail.com>
parents: 776
diff changeset
   104
    return super(View, self).edit(request, access_type, page_name=page_name,
bc13cd968946 Added support for mutliple edit forms based on entity type
Sverre Rabbelier <srabbelier@gmail.com>
parents: 776
diff changeset
   105
                                  params=params, seed=seed, **kwargs)
793
4bde741aa2bb Resolved a bug when editing a timeline.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 784
diff changeset
   106
  
4bde741aa2bb Resolved a bug when editing a timeline.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 784
diff changeset
   107
  def _editPost(self, request, entity, fields):
4bde741aa2bb Resolved a bug when editing a timeline.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 784
diff changeset
   108
    """See base.View._editPost().
4bde741aa2bb Resolved a bug when editing a timeline.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 784
diff changeset
   109
    """
4bde741aa2bb Resolved a bug when editing a timeline.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 784
diff changeset
   110
    
4bde741aa2bb Resolved a bug when editing a timeline.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 784
diff changeset
   111
    # a timeline can only be edited, so set the scope path using entity
4bde741aa2bb Resolved a bug when editing a timeline.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 784
diff changeset
   112
    fields['scope_path'] = entity.scope_path
778
bc13cd968946 Added support for mutliple edit forms based on entity type
Sverre Rabbelier <srabbelier@gmail.com>
parents: 776
diff changeset
   113
768
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   114
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   115
view = View()
002d3141ff99 Added logic and view classes for the Timeline model
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   116
1584
d8ba8c917f37 Make use of decorators.view for all views
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1583
diff changeset
   117
admin = decorators.view(view.admin)
d8ba8c917f37 Make use of decorators.view for all views
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1583
diff changeset
   118
create = decorators.view(view.create)
d8ba8c917f37 Make use of decorators.view for all views
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1583
diff changeset
   119
delete = decorators.view(view.delete)
d8ba8c917f37 Make use of decorators.view for all views
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1583
diff changeset
   120
edit = decorators.view(view.edit)
d8ba8c917f37 Make use of decorators.view for all views
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1583
diff changeset
   121
list = decorators.view(view.list)
d8ba8c917f37 Make use of decorators.view for all views
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1583
diff changeset
   122
public = decorators.view(view.public)
d8ba8c917f37 Make use of decorators.view for all views
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1583
diff changeset
   123
export = decorators.view(view.export)
858
e79e7a22326f Add an export() view, and implement it as text/text for Document.
Todd Larsen <tlarsen@google.com>
parents: 847
diff changeset
   124