src/web/__init__.py

   1 #!/usr/bin/python
   2 # encoding: utf-8
   3
   4 import logging
   5 import multiprocessing
   6 import os.path
   7 import tornado.httpserver
   8 import tornado.locale
   9 import tornado.options
  10 import tornado.web
  11
  12 from .. import Backend
  13 from ..constants import *
  14 from ..decorators import *
  15
  16 from .handlers import *
  17
  18 from . import handlers_api
  19 from . import mirrors
  20 from . import ui_modules
  21
  22 # Enable logging
  23 tornado.options.define("debug", default=False, help="Run in debug mode", type=bool)
  24 tornado.options.parse_command_line()
  25
  26 class Application(tornado.web.Application):
  27         def __init__(self, **_settings):
  28                 settings = dict(
  29                         debug = tornado.options.options.debug,
  30                         gzip  = True,
  31                         login_url = "/login",
  32                         template_path = TEMPLATESDIR,
  33                         static_path = STATICDIR,
  34                         ui_modules = {
  35                                 "Text"               : ui_modules.TextModule,
  36                                 "Modal"              : ui_modules.ModalModule,
  37
  38                                 "Footer"             : ui_modules.FooterModule,
  39
  40                                 # Logging
  41                                 "Log"                : ui_modules.LogModule,
  42                                 "LogEntry"           : ui_modules.LogEntryModule,
  43                                 "LogEntryComment"    : ui_modules.LogEntryCommentModule,
  44
  45                                 # Builders
  46                                 "BuildersLoad"       : ui_modules.BuildersLoadModule,
  47
  48                                 "BuildHeadline"      : ui_modules.BuildHeadlineModule,
  49                                 "BuildStateWarnings" : ui_modules.BuildStateWarningsModule,
  50
  51                                 "BugsTable"          : ui_modules.BugsTableModule,
  52                                 "BuildLog"           : ui_modules.BuildLogModule,
  53                                 "BuildOffset"        : ui_modules.BuildOffsetModule,
  54                                 "BuildTable"         : ui_modules.BuildTableModule,
  55
  56                                 # Changelog
  57                                 "Changelog"          : ui_modules.ChangelogModule,
  58                                 "ChangelogEntry"     : ui_modules.ChangelogEntryModule,
  59
  60                                 # Jobs
  61                                 "JobsList"           : ui_modules.JobsListModule,
  62                                 "JobsStatus"         : ui_modules.JobsStatusModule,
  63
  64                                 # Packages
  65                                 "PackagesDependencyTable" : ui_modules.PackagesDependencyTableModule,
  66
  67                                 "CommitMessage"      : ui_modules.CommitMessageModule,
  68                                 "CommitsTable"       : ui_modules.CommitsTableModule,
  69                                 "JobsBoxes"          : ui_modules.JobsBoxesModule,
  70                                 "JobState"           : ui_modules.JobStateModule,
  71                                 "JobsTable"          : ui_modules.JobsTableModule,
  72                                 "CommentsTable"      : ui_modules.CommentsTableModule,
  73                                 "FilesTable"         : ui_modules.FilesTableModule,
  74                                 "LogTable"           : ui_modules.LogTableModule,
  75                                 "LogFilesTable"      : ui_modules.LogFilesTableModule,
  76                                 "Maintainer"         : ui_modules.MaintainerModule,
  77                                 "PackagesTable"      : ui_modules.PackagesTableModule,
  78                                 "PackageTable2"      : ui_modules.PackageTable2Module,
  79                                 "PackageHeader"      : ui_modules.PackageHeaderModule,
  80                                 "PackageFilesTable"  : ui_modules.PackageFilesTableModule,
  81                                 "RepositoryTable"    : ui_modules.RepositoryTableModule,
  82                                 "RepoActionsTable"   : ui_modules.RepoActionsTableModule,
  83                                 "SourceTable"        : ui_modules.SourceTableModule,
  84                                 "UpdatesTable"       : ui_modules.UpdatesTableModule,
  85                                 "UsersTable"         : ui_modules.UsersTableModule,
  86                                 "WatchersSidebarTable" : ui_modules.WatchersSidebarTableModule,
  87
  88                                 "SelectLocale"       : ui_modules.SelectLocaleModule,
  89                                 "SelectTimezone"     : ui_modules.SelectTimezoneModule,
  90                         },
  91                         ui_methods = {
  92                                 "format_eta"         : self.format_eta,
  93                                 "format_time"        : self.format_time,
  94                         },
  95                         xsrf_cookies = True,
  96                 )
  97                 settings.update(_settings)
  98
  99                 # Load translations.
 100                 tornado.locale.load_gettext_translations(LOCALEDIR, PACKAGE_NAME)
 101
 102                 tornado.web.Application.__init__(self, [
 103                         # Entry site that lead the user to index
 104                         (r"/", IndexHandler),
 105
 106                         # Handle all the users logins/logouts/registers and stuff.
 107                         (r"/login", LoginHandler),
 108                         (r"/logout", LogoutHandler),
 109                         (r"/register", RegisterHandler),
 110                         (r"/password-recovery", PasswordRecoveryHandler),
 111
 112                         # User profiles
 113                         (r"/users", UsersHandler),
 114                         (r"/user/impersonate", UserImpersonateHandler),
 115                         (r"/user/(\w+)/passwd", UserPasswdHandler),
 116                         (r"/user/(\w+)/delete", UserDeleteHandler),
 117                         (r"/user/(\w+)/edit", UserEditHandler),
 118                         (r"/user/(\w+)/activate", ActivationHandler),
 119                         (r"/user/(\w+)", UserHandler),
 120                         (r"/profile", UserHandler),
 121                         (r"/profile/builds", UsersBuildsHandler),
 122
 123                         # Packages
 124                         (r"/packages", PackageListHandler),
 125                         (r"/package/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})", PackageDetailHandler),
 126                         (r"/package/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/download(.*)", PackageFileDownloadHandler),
 127                         (r"/package/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/view(.*)", PackageFileViewHandler),
 128                         (r"/package/([\w\-\+]+)", PackageNameHandler),
 129                         (r"/package/([\w\-\+]+)/builds/scratch", PackageScratchBuildsHandler),
 130                         (r"/package/([\w\-\+]+)/builds/times", PackageBuildsTimesHandler),
 131                         (r"/package/([\w\-\+]+)/changelog", PackageChangelogHandler),
 132                         (r"/package/([\w\-\+]+)/properties", PackagePropertiesHandler),
 133
 134                         # Files
 135                         (r"/file/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})", FileDetailHandler),
 136
 137                         # Builds
 138                         (r"/builds", BuildsHandler),
 139                         (r"/builds/filter", BuildFilterHandler),
 140                         (r"/builds/queue", BuildQueueHandler),
 141                         (r"/builds/comments", BuildsCommentsHandler),
 142                         (r"/builds/comments/(\w+)", BuildsCommentsHandler),
 143                         (r"/build/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})", BuildDetailHandler),
 144                         (r"/build/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/bugs", BuildBugsHandler),
 145                         (r"/build/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/manage", BuildManageHandler),
 146                         (r"/build/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/comment", BuildDetailCommentHandler),
 147                         (r"/build/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/priority", BuildPriorityHandler),
 148                         (r"/build/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/state", BuildStateHandler),
 149                         (r"/build/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/watch", BuildWatchersAddHandler),
 150                         (r"/build/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/watchers", BuildWatchersHandler),
 151                         (r"/build/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/delete", BuildDeleteHandler),
 152
 153                         # Jobs
 154                         (r"/jobs", JobsIndexHandler),
 155                         (r"/jobs/filter", JobsFilterHandler),
 156                         (r"/job/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})", JobDetailHandler),
 157                         (r"/job/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/abort", JobAbortHandler),
 158                         (r"/job/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/buildroot", JobBuildrootHandler),
 159                         (r"/job/([\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12})/schedule", JobScheduleHandler),
 160
 161                         # Builders
 162                         (r"/builders", BuilderListHandler),
 163                         (r"/builder/new", BuilderNewHandler),
 164                         (r"/builder/([A-Za-z0-9\-\.]+)/enable", BuilderEnableHander),
 165                         (r"/builder/([A-Za-z0-9\-\.]+)/disable", BuilderDisableHander),
 166                         (r"/builder/([A-Za-z0-9\-\.]+)/delete", BuilderDeleteHandler),
 167                         (r"/builder/([A-Za-z0-9\-\.]+)/edit", BuilderEditHandler),
 168                         (r"/builder/([A-Za-z0-9\-\.]+)/renew", BuilderRenewPassphraseHandler),
 169                         (r"/builder/([A-Za-z0-9\-\.]+)", BuilderDetailHandler),
 170
 171                         # Distributions
 172                         (r"/distros", DistributionListHandler),
 173                         (r"/distro/([A-Za-z0-9\-\.]+)", DistributionDetailHandler),
 174
 175                         # XXX THOSE URLS ARE DEPRECATED
 176                         (r"/distribution/delete/([A-Za-z0-9\-\.]+)", DistributionDetailHandler),
 177                         (r"/distribution/edit/([A-Za-z0-9\-\.]+)", DistributionEditHandler),
 178
 179                         (r"/distro/([A-Za-z0-9\-\.]+)/repo/([A-Za-z0-9\-]+)",
 180                                 RepositoryDetailHandler),
 181                         (r"/distro/([A-Za-z0-9\-\.]+)/repo/([A-Za-z0-9\-]+)\.repo",
 182                                 RepositoryConfHandler),
 183                         (r"/distro/([A-Za-z0-9\-\.]+)/repo/([A-Za-z0-9\-]+)/mirrorlist",
 184                                 RepositoryMirrorlistHandler),
 185                         (r"/distro/([A-Za-z0-9\-\.]+)/repo/([A-Za-z0-9\-]+)/edit",
 186                                 RepositoryEditHandler),
 187
 188                         (r"/distro/([A-Za-z0-9\-\.]+)/source/([A-Za-z0-9\-\.]+)",
 189                                 DistroSourceDetailHandler),
 190                         (r"/distro/([A-Za-z0-9\-\.]+)/source/([A-Za-z0-9\-\.]+)/commits",
 191                                 DistroSourceCommitsHandler),
 192                         (r"/distro/([A-Za-z0-9\-\.]+)/source/([A-Za-z0-9\-\.]+)/([\w]{40})",
 193                                 DistroSourceCommitDetailHandler),
 194                         (r"/distro/([A-Za-z0-9\-\.]+)/source/([A-Za-z0-9\-\.]+)/([\w]{40})/reset",
 195                                 DistroSourceCommitResetHandler),
 196
 197                         (r"/distro/([A-Za-z0-9\-\.]+)/update/create",
 198                                 DistroUpdateCreateHandler),
 199                         (r"/distro/([A-Za-z0-9\-\.]+)/update/(\d+)/(\d+)",
 200                                 DistroUpdateDetailHandler),
 201
 202                         # Updates
 203                         (r"/updates", UpdatesHandler),
 204
 205                         # Mirrors
 206                         (r"/mirrors",                                   mirrors.MirrorListHandler),
 207                         (r"/mirror/new",                                mirrors.MirrorNewHandler),
 208                         (r"/mirror/([\w\-\.]+)/delete", mirrors.MirrorDeleteHandler),
 209                         (r"/mirror/([\w\-\.]+)/edit",   mirrors.MirrorEditHandler),
 210                         (r"/mirror/([\w\-\.]+)",                mirrors.MirrorDetailHandler),
 211
 212                         # Key management
 213                         (r"/keys", KeysListHandler),
 214                         (r"/key/import", KeysImportHandler),
 215                         (r"/key/([A-Z0-9]+)", KeysDownloadHandler),
 216                         (r"/key/([A-Z0-9]+)/delete", KeysDeleteHandler),
 217
 218                         # Statistics
 219                         (r"/statistics", StatisticsMainHandler),
 220
 221                         # Documents
 222                         (r"/documents", DocsIndexHandler),
 223                         (r"/documents/builds", DocsBuildsHandler),
 224                         (r"/documents/users", DocsUsersHandler),
 225                         (r"/documents/what-is-the-pakfire-build-service", DocsWhatsthisHandler),
 226
 227                         # Search
 228                         (r"/search", SearchHandler),
 229
 230                         # Uploads
 231                         (r"/uploads", UploadsHandler),
 232
 233                         # Log
 234                         (r"/log", LogHandler),
 235
 236                         # Sessions
 237                         (r"/sessions", SessionsHandler),
 238
 239                         # API handlers
 240                         (r"/api/packages/autocomplete", handlers_api.ApiPackagesAutocomplete),
 241                 ], **settings)
 242
 243                 logging.info("Successfully initialied application")
 244
 245         @lazy_property
 246         def backend(self):
 247                 """
 248                         Backend connection
 249                 """
 250                 return Backend()
 251
 252         def __del__(self):
 253                 logging.info("Shutting down application")
 254
 255         @property
 256         def ioloop(self):
 257                 return tornado.ioloop.IOLoop.instance()
 258
 259         def shutdown(self, *args):
 260                 logging.debug("Caught shutdown signal")
 261                 self.ioloop.stop()
 262
 263         def run(self, port=7001):
 264                 logging.debug("Going to background")
 265
 266                 http_server = tornado.httpserver.HTTPServer(self, xheaders=True)
 267
 268                 # If we are not running in debug mode, we can actually run multiple
 269                 # frontends to get best performance out of our service.
 270                 if self.settings.get("debug", False):
 271                         http_server.listen(port)
 272                 else:
 273                         cpu_count = multiprocessing.cpu_count()
 274
 275                         http_server.bind(port)
 276                         http_server.start(num_processes=cpu_count)
 277
 278                 # All requests should be done after 60 seconds or they will be killed.
 279                 self.ioloop.set_blocking_log_threshold(60)
 280
 281                 self.ioloop.start()
 282
 283         def reload(self):
 284                 logging.debug("Caught reload signal")
 285
 286         ## UI methods
 287
 288         def format_eta(self, handler, (s, stddev)):
 289                 if s is None:
 290                         _ = handler.locale.translate
 291                         return _("Unknown")
 292
 293                 if s < 0:
 294                         s = 0
 295
 296                 return u"%s ± %s" % (
 297                         self.format_time(handler, s),
 298                         self.format_time_short(handler, stddev / 2),
 299                 )
 300
 301         def format_time(self, handler, s, shorter=False):
 302                 _ = handler.locale.translate
 303
 304                 hrs, s = divmod(s, 3600)
 305                 min, s = divmod(s, 60)
 306
 307                 if s >= 30:
 308                         min += 1
 309
 310                 if shorter and not hrs:
 311                         return _("%(min)d min") % { "min" : min }
 312
 313                 return _("%(hrs)d:%(min)02d hrs") % {"hrs" : hrs, "min" : min}
 314
 315         def format_time_short(self, handler, s):
 316                 _ = handler.locale.translate
 317
 318                 hrs = s / 3600
 319                 if hrs >= 1:
 320                         return _("%dh") % hrs
 321
 322                 min = s / 60
 323                 if min >= 1:
 324                         return _("%dm") % min
 325
 326                 return _("%ds") % s