git.ozlabs.org Git - patchwork/blob - patchwork/views/__init__.py

   1 # Patchwork - automated patch tracking system
   2 # Copyright (C) 2008 Jeremy Kerr <jk@ozlabs.org>
   3 #
   4 # This file is part of the Patchwork package.
   5 #
   6 # Patchwork is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # Patchwork is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with Patchwork; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19
  20
  21 from base import *
  22 from patchwork.utils import Order, get_patch_ids, bundle_actions, set_bundle
  23 from patchwork.paginator import Paginator
  24 from patchwork.forms import MultiplePatchForm
  25 from patchwork.models import Comment
  26 import re
  27 import datetime
  28
  29 try:
  30     from email.mime.nonmultipart import MIMENonMultipart
  31     from email.encoders import encode_7or8bit
  32     from email.parser import HeaderParser
  33     from email.header import Header
  34     import email.utils
  35 except ImportError:
  36     # Python 2.4 compatibility
  37     from email.MIMENonMultipart import MIMENonMultipart
  38     from email.Encoders import encode_7or8bit
  39     from email.Parser import HeaderParser
  40     from email.Header import Header
  41     import email.Utils
  42     email.utils = email.Utils
  43
  44 def generic_list(request, project, view,
  45         view_args = {}, filter_settings = [], patches = None,
  46         editable_order = False):
  47
  48     context = PatchworkRequestContext(request,
  49             list_view = view,
  50             list_view_params = view_args)
  51
  52     context.project = project
  53     order = Order(request.REQUEST.get('order'), editable = editable_order)
  54
  55     # Explicitly set data to None because request.POST will be an empty dict
  56     # when the form is not submitted, but passing a non-None data argument to
  57     # a forms.Form will make it bound and we don't want that to happen unless
  58     # there's been a form submission.
  59     data = None
  60     if request.method == 'POST':
  61         data = request.POST
  62     user = request.user
  63     properties_form = None
  64     if project.is_editable(user):
  65
  66         # we only pass the post data to the MultiplePatchForm if that was
  67         # the actual form submitted
  68         data_tmp = None
  69         if data and data.get('form', '') == 'patchlistform':
  70             data_tmp = data
  71
  72         properties_form = MultiplePatchForm(project, data = data_tmp)
  73
  74     if request.method == 'POST' and data.get('form') == 'patchlistform':
  75         action = data.get('action', '').lower()
  76
  77         # special case: the user may have hit enter in the 'create bundle'
  78         # text field, so if non-empty, assume the create action:
  79         if data.get('bundle_name', False):
  80             action = 'create'
  81
  82         ps = Patch.objects.filter(id__in = get_patch_ids(data))
  83
  84         if action in bundle_actions:
  85             errors = set_bundle(user, project, action, data, ps, context)
  86
  87         elif properties_form and action == properties_form.action:
  88             errors = process_multiplepatch_form(properties_form, user,
  89                                                 action, ps, context)
  90         else:
  91             errors = []
  92
  93         if errors:
  94             context['errors'] = errors
  95
  96     for (filterclass, setting) in filter_settings:
  97         if isinstance(setting, dict):
  98             context.filters.set_status(filterclass, **setting)
  99         elif isinstance(setting, list):
 100             context.filters.set_status(filterclass, *setting)
 101         else:
 102             context.filters.set_status(filterclass, setting)
 103
 104     if patches is None:
 105         patches = Patch.objects.filter(project=project)
 106
 107     # annotate with tag counts
 108     patches = patches.with_tag_counts(project)
 109
 110     patches = context.filters.apply(patches)
 111     if not editable_order:
 112         patches = order.apply(patches)
 113
 114     # we don't need the content or headers for a list; they're text fields
 115     # that can potentially contain a lot of data
 116     patches = patches.defer('content', 'headers')
 117
 118     # but we will need to follow the state and submitter relations for
 119     # rendering the list template
 120     patches = patches.select_related('state', 'submitter', 'delegate')
 121
 122     paginator = Paginator(request, patches)
 123
 124     context.update({
 125             'page':             paginator.current_page,
 126             'patchform':        properties_form,
 127             'project':          project,
 128             'order':            order,
 129             })
 130
 131     return context
 132
 133
 134 def process_multiplepatch_form(form, user, action, patches, context):
 135     errors = []
 136     if not form.is_valid() or action != form.action:
 137         return ['The submitted form data was invalid']
 138
 139     if len(patches) == 0:
 140         context.add_message("No patches selected; nothing updated")
 141         return errors
 142
 143     changed_patches = 0
 144     for patch in patches:
 145         if not patch.is_editable(user):
 146             errors.append("You don't have permissions to edit patch '%s'"
 147                             % patch.name)
 148             continue
 149
 150         changed_patches += 1
 151         form.save(patch)
 152
 153     if changed_patches == 1:
 154         context.add_message("1 patch updated")
 155     elif changed_patches > 1:
 156         context.add_message("%d patches updated" % changed_patches)
 157     else:
 158         context.add_message("No patches updated")
 159
 160     return errors
 161
 162 class PatchMbox(MIMENonMultipart):
 163     patch_charset = 'utf-8'
 164     def __init__(self, _text):
 165         MIMENonMultipart.__init__(self, 'text', 'plain',
 166                         **{'charset': self.patch_charset})
 167         self.set_payload(_text.encode(self.patch_charset))
 168         encode_7or8bit(self)
 169
 170 def patch_to_mbox(patch):
 171     postscript_re = re.compile('\n-{2,3} ?\n')
 172
 173     comment = None
 174     try:
 175         comment = Comment.objects.get(patch = patch, msgid = patch.msgid)
 176     except Exception:
 177         pass
 178
 179     body = ''
 180     if comment:
 181         body = comment.content.strip() + "\n"
 182
 183     parts = postscript_re.split(body, 1)
 184     if len(parts) == 2:
 185         (body, postscript) = parts
 186         body = body.strip() + "\n"
 187         postscript = postscript.rstrip()
 188     else:
 189         postscript = ''
 190
 191     for comment in Comment.objects.filter(patch = patch) \
 192             .exclude(msgid = patch.msgid):
 193         body += comment.patch_responses()
 194
 195     if postscript:
 196         body += '---\n' + postscript + '\n'
 197
 198     if patch.content:
 199         body += '\n' + patch.content
 200
 201     delta = patch.date - datetime.datetime.utcfromtimestamp(0)
 202     utc_timestamp = delta.seconds + delta.days*24*3600
 203
 204     mail = PatchMbox(body)
 205     mail['Subject'] = patch.name
 206     mail['From'] = email.utils.formataddr((
 207                     str(Header(patch.submitter.name, mail.patch_charset)),
 208                     patch.submitter.email))
 209     mail['X-Patchwork-Id'] = str(patch.id)
 210     mail['Message-Id'] = patch.msgid
 211     mail.set_unixfrom('From patchwork ' + patch.date.ctime())
 212
 213
 214     copied_headers = ['To', 'Cc', 'Date']
 215     orig_headers = HeaderParser().parsestr(str(patch.headers))
 216     for header in copied_headers:
 217         if header in orig_headers:
 218             mail[header] = orig_headers[header]
 219
 220     if 'Date' not in mail:
 221         mail['Date'] = email.utils.formatdate(utc_timestamp)
 222
 223     return mail