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