indico/MaKaC/webinterface/pages/base.py

   1 # -*- coding: utf-8 -*-
   2 ##
   3 ##
   4 ## This file is part of CDS Indico.
   5 ## Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 CERN.
   6 ##
   7 ## CDS Indico is free software; you can redistribute it and/or
   8 ## modify it under the terms of the GNU General Public License as
   9 ## published by the Free Software Foundation; either version 2 of the
  10 ## License, or (at your option) any later version.
  11 ##
  12 ## CDS Indico is distributed in the hope that it will be useful, but
  13 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 ## General Public License for more details.
  16 ##
  17 ## You should have received a copy of the GNU General Public License
  18 ## along with CDS Indico; if not, write to the Free Software Foundation, Inc.,
  19 ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  20
  21 import MaKaC.webinterface.wcomponents as wcomponents
  22 import MaKaC.webinterface.urlHandlers as urlHandlers
  23 from MaKaC.common.Configuration import Config
  24 from MaKaC.common.info import HelperMaKaCInfo
  25 from MaKaC.i18n import _
  26 from indico.util.i18n import i18nformat
  27
  28 from MaKaC.plugins.base import OldObservable
  29
  30
  31 class WPBase(OldObservable):
  32     """
  33     """
  34     _title = "Indico"
  35
  36     # required user-specific "data packages"
  37     _userData = []
  38
  39     def __init__( self, rh ):
  40         self._rh = rh
  41         self._locTZ = ""
  42
  43         #store page specific CSS and JS
  44         self._extraCSS = []
  45         self._extraJS = []
  46
  47     def _includeJSPackage(self, packageName, module = 'indico', path=None):
  48         info = HelperMaKaCInfo().getMaKaCInfoInstance()
  49
  50         if info.isDebugActive():
  51             return ['js/%s/%s/Loader.js' % (module, packageName)]
  52         else:
  53             return ['js/%s/pack/%s.js.pack' % (module, packageName)]
  54
  55     def _includeJQuery(self):
  56         info = HelperMaKaCInfo().getMaKaCInfoInstance()
  57         files = ['underscore', 'jquery', 'jquery-ui', 'jquery.form', 'jquery.custom', 'jquery.daterange', 'jquery.qtip']
  58         if info.isDebugActive():
  59             # We can't use Loader.js as jQuery is included before any indico js
  60             return ['js/jquery/%s.js' % f for f in files] + ['js/indico/jquery/defaults.js']
  61         else:
  62             return ['js/jquery/pack/jquery.js.pack'] + ['js/indico/jquery/defaults.js']
  63
  64     def _includeJSFile(self, path, filename):
  65         info = HelperMaKaCInfo().getMaKaCInfoInstance()
  66
  67         if info.isDebugActive():
  68             return ['%s/%s.js' % (path, filename)]
  69         else:
  70             return ['%s/%s.js.pack' % (path, filename)]
  71
  72     def _includePresentationFiles(self):
  73         info = HelperMaKaCInfo().getMaKaCInfoInstance()
  74
  75         if info.isDebugActive():
  76             return ['js/presentation/Loader.js']
  77         else:
  78             return ['js/presentation/pack/Presentation.js.pack']
  79
  80     def _getBaseURL( self ):
  81         if self._rh._req.is_https() and Config.getInstance().getBaseSecureURL():
  82             baseurl = Config.getInstance().getBaseSecureURL()
  83         else:
  84             baseurl = Config.getInstance().getBaseURL()
  85         return baseurl
  86
  87     def _getTitle( self ):
  88         return self._title
  89
  90     def _setTitle( self, newTitle ):
  91         self._title = newTitle.strip()
  92
  93     def getCSSFiles(self):
  94         return []
  95
  96     def getJSFiles(self):
  97         return self._includePresentationFiles() + \
  98                self._includeJQuery() + \
  99                self._includeJSPackage('Core') + \
 100                self._includeJSPackage('Legacy') + \
 101                self._includeJSPackage('Common')
 102
 103     def _getJavaScriptInclude(self, scriptPath):
 104         return '<script src="'+ scriptPath +'" type="text/javascript"></script>\n'
 105
 106     def _getJavaScriptUserData(self):
 107         """
 108         Returns structured data that should be passed on to the client side
 109         but depends on user data (can't be in vars.js.tpl)
 110         """
 111
 112         user = self._getAW().getUser();
 113
 114         from MaKaC.webinterface.asyndico import UserDataFactory
 115
 116         userData = dict((packageName,
 117                          UserDataFactory(user).build(packageName))
 118                         for packageName in self._userData)
 119
 120         return userData
 121
 122     def _getHeadContent( self ):
 123         """
 124         Returns _additional_ content between <head></head> tags.
 125         Please note that <title>, <meta> and standard CSS are always included.
 126
 127         Override this method to add your own, page-specific loading of
 128         JavaScript, CSS and other legal content for HTML <head> tag.
 129         """
 130         return ""
 131
 132     def _getWarningMessage(self):
 133         return ""
 134
 135     def _getHTMLHeader( self ):
 136         from MaKaC.webinterface.pages.conferences import WPConfSignIn
 137         from MaKaC.webinterface.pages.signIn import WPSignIn
 138         from MaKaC.webinterface.pages.registrationForm import WPRegistrationFormSignIn
 139         from MaKaC.webinterface.rh.base import RHModificationBaseProtected
 140         from MaKaC.webinterface.rh.admins import RHAdminBase
 141
 142         area=""
 143         if isinstance(self._rh, RHModificationBaseProtected):
 144             area=i18nformat(""" - _("Management area")""")
 145         elif isinstance(self._rh, RHAdminBase):
 146             area=i18nformat(""" - _("Administrator area")""")
 147
 148         info = HelperMaKaCInfo().getMaKaCInfoInstance()
 149         websession = self._getAW().getSession()
 150         if websession:
 151             language = websession.getLang()
 152         else:
 153             language = info.getLang()
 154
 155         return wcomponents.WHTMLHeader().getHTML({
 156             "area": area,
 157             "baseurl": self._getBaseURL(),
 158             "conf": Config.getInstance(),
 159             "page": self,
 160             "extraCSS": self.getCSSFiles(),
 161             "extraJSFiles": self.getJSFiles(),
 162             "extraJS": self._extraJS,
 163             "language": language,
 164             "social": info.getSocialAppConfig()
 165             })
 166
 167     def _getHTMLFooter( self ):
 168         return """
 169     </body>
 170 </html>
 171                """
 172
 173     def _display( self, params ):
 174         """
 175         """
 176         return _("no content")
 177
 178     def _getAW( self ):
 179         return self._rh.getAW()
 180
 181     def display( self, **params ):
 182         """
 183         """
 184         return "%s%s%s"%( self._getHTMLHeader(), \
 185                             self._display( params ), \
 186                             self._getHTMLFooter() )
 187
 188
 189     def addExtraJSFile(self, filename):
 190         self._extraJSFiles.append(filename)
 191
 192     def addExtraJS(self, jsCode):
 193         self._extraJS.append(jsCode)
 194
 195     # auxiliar functions
 196     def _escapeChars(self, text):
 197         # Not doing anything right now - it used to convert % to %% for old-style templates
 198         return text
 199
 200
 201 class WPDecorated( WPBase ):
 202
 203     def _getSiteArea(self):
 204         return "DisplayArea"
 205
 206     def getLoginURL( self ):
 207         return urlHandlers.UHSignIn.getURL("%s"%self._rh.getCurrentURL())
 208
 209     def getLogoutURL( self ):
 210         return urlHandlers.UHSignOut.getURL("%s"%self._rh.getCurrentURL())
 211
 212     def getLoginAsURL( self ):
 213         return urlHandlers.UHLogMeAs.getURL("%s"%self._rh.getCurrentURL())
 214
 215     def _getHeader( self ):
 216         """
 217         """
 218         wc = wcomponents.WHeader( self._getAW(), isFrontPage=self._isFrontPage(), currentCategory=self._currentCategory(), locTZ=self._locTZ )
 219
 220         return wc.getHTML( { "subArea": self._getSiteArea(), \
 221                              "loginURL": self._escapeChars(str(self.getLoginURL())),\
 222                              "logoutURL": self._escapeChars(str(self.getLogoutURL())),\
 223                              "loginAsURL": self.getLoginAsURL() } )
 224
 225     def _getTabControl(self):
 226         return None
 227
 228     def _getFooter( self):
 229         """
 230         """
 231         wc = wcomponents.WFooter(isFrontPage=self._isFrontPage())
 232         return wc.getHTML({ "subArea": self._getSiteArea() })
 233
 234     def _applyDecoration( self, body ):
 235         """
 236         """
 237         return "<div class=\"wrapper\"><div class=\"main\">%s%s</div></div>%s"%( self._getHeader(), body, self._getFooter() )
 238
 239     def _display( self, params ):
 240
 241         return self._applyDecoration( self._getBody( params ) )
 242
 243     def _getBody( self, params ):
 244         """
 245         """
 246         pass
 247
 248     def _getNavigationDrawer(self):
 249         return None
 250
 251     def _isFrontPage(self):
 252         """
 253             Welcome page class overloads this, so that additional info (news, policy)
 254             is shown.
 255         """
 256         return False
 257
 258     def _isRoomBooking(self):
 259         return False
 260
 261     def _currentCategory(self):
 262         """
 263             Whenever in category display mode this is overloaded with the current category
 264         """
 265         return None
 266
 267     def _getSideMenu(self):
 268         """
 269             Overload and return side menu whenever there is one
 270         """
 271         return None
 272
 273 class WPNotDecorated( WPBase ):
 274
 275     def getLoginURL( self ):
 276         return urlHandlers.UHSignIn.getURL("%s"%self._rh.getCurrentURL())
 277
 278     def getLogoutURL( self ):
 279         return urlHandlers.UHSignOut.getURL("%s"%self._rh.getCurrentURL())
 280
 281     def _display( self, params ):
 282         return self._getBody( params )
 283
 284     def _getBody( self, params ):
 285         """
 286         """
 287         pass
 288
 289     def _getNavigationDrawer(self):
 290         return None
 291
 292
 293