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