indico/MaKaC/errors.py

   1 # This file is part of Indico.
   2 # Copyright (C) 2002 - 2015 European Organization for Nuclear Research (CERN).
   3 #
   4 # Indico is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU General Public License as
   6 # published by the Free Software Foundation; either version 3 of the
   7 # License, or (at your option) any later version.
   8 #
   9 # Indico is distributed in the hope that it will be useful, but
  10 # WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with Indico; if not, see <http://www.gnu.org/licenses/>.
  16
  17 """
  18 Module containing the MaKaC exception class hierarchy
  19 """
  20
  21 from MaKaC.common.fossilize import fossilizes, Fossilizable
  22 from indico.core.fossils.errors import IErrorReportFossil, IErrorNoReportFossil
  23 from indico.util.translations import ensure_str
  24
  25
  26 class MaKaCError(Exception, Fossilizable):
  27
  28     fossilizes(IErrorReportFossil)
  29
  30     def __init__(self, msg="", area="", explanation=None):
  31         self._msg = msg
  32         self._area = area
  33         self._explanation = explanation
  34
  35     def getMessage(self):
  36         return self._msg
  37
  38     @ensure_str
  39     def __str__(self):
  40         if self._area != "":
  41             return "%s - %s" % (self._area, self._msg)
  42         else:
  43             return self._msg
  44
  45     def getArea(self):
  46         return self._area
  47
  48     def getExplanation(self):
  49         """
  50         Some extra information, like actions that can be taken
  51         """
  52
  53         return self._explanation
  54
  55
  56 class AccessControlError(MaKaCError):
  57     """
  58     """
  59
  60     fossilizes(IErrorNoReportFossil)
  61
  62     def __init__(self, objectType="object"):
  63         MaKaCError.__init__(self)
  64         self.objType = objectType
  65
  66     @ensure_str
  67     def __str__(self):
  68         return _("you are not authorised to access this %s") % self.objType
  69
  70     def getMessage(self):
  71         return str(self)
  72
  73
  74 class ConferenceClosedError(MaKaCError):
  75     """
  76     """
  77     fossilizes(IErrorNoReportFossil)
  78
  79     def __init__(self, conf):
  80         MaKaCError.__init__(self)
  81         self._conf = conf
  82
  83     @ensure_str
  84     def __str__(self):
  85         return _("the event has been closed")
  86
  87
  88 class AccessError(AccessControlError):
  89     """
  90     """
  91     pass
  92
  93
  94 class KeyAccessError(AccessControlError):
  95     """
  96     """
  97     pass
  98
  99
 100 class ModificationError(AccessControlError):
 101     """
 102     """
 103
 104     @ensure_str
 105     def __str__(self):
 106         return _("you are not authorised to modify this %s") % self.objType
 107
 108
 109 class AdminError(AccessControlError):
 110     """
 111     """
 112
 113     @ensure_str
 114     def __str__(self):
 115         return _("only administrators can access this %s") % self.objType
 116
 117
 118 class TimingError(MaKaCError):
 119     """
 120     Timetable problems
 121     """
 122
 123     fossilizes(IErrorNoReportFossil)
 124
 125
 126 class ParentTimingError(TimingError):
 127     """
 128     """
 129     pass
 130
 131
 132 class EntryTimingError(TimingError):
 133     """
 134     """
 135     pass
 136
 137
 138 class UserError(MaKaCError):
 139     """
 140     """
 141
 142     @ensure_str
 143     def __str__(self):
 144         if self._msg:
 145             return self._msg
 146         else:
 147             return _("Error creating user")
 148
 149
 150 class NotLoggedError(MaKaCError):
 151     """
 152     """
 153     fossilizes(IErrorNoReportFossil)
 154
 155
 156 class FormValuesError(MaKaCError):
 157     """
 158     """
 159     fossilizes(IErrorNoReportFossil)
 160
 161
 162 class NoReportError(MaKaCError):
 163     """
 164     """
 165     fossilizes(IErrorNoReportFossil)
 166
 167
 168 class NotFoundError(MaKaCError):
 169     """
 170     MaKaC's own NotFound version (just for legacy support)
 171     """
 172     fossilizes(IErrorNoReportFossil)
 173
 174     def __init__(self, message, title=""):
 175         if not title:
 176             title = message
 177             message = ''
 178         super(NotFoundError, self).__init__(title, explanation=message)
 179
 180
 181 class HtmlForbiddenTag(MaKaCError):
 182     """
 183     """
 184     pass
 185
 186
 187 class BadRefererError(MaKaCError):
 188     pass