View Reference

The views.security Module

Security view callables.

publiforge.views.security.login(request)

This view renders a login form and processes the post checking credentials.

publiforge.views.security.logout(request)

This view will clear the credentials of the logged in user and redirect back to the login page.

class publiforge.views.security.ErrorView(request)

Class to manage error page.

error()

This view outputs an error message or redirects to login page.

The views.maintenance Module

Maintenance view callables.

publiforge.views.maintenance.mainatenance_view(request)

Maintenance view.

Parameters:request (pyramid.request.Request) – Current request.

The views.home Module

Home view callables.

class publiforge.views.home.HomeView(request)

Class to manage Home pages.

index()

Index page.

publiforge.views.home.favicon(request)

Output the favicon.ico file.

publiforge.views.home.robots(request)

Output the robots.txt file.

The views.user Module

User view callables.

class publiforge.views.user.UserView(request)

Class to manage users.

admin()

List users for administration purpose.

view()

Show user settings.

create()

Create a user.

edit()

Edit user settings.

The views.selection Module

Selection view callables.

class publiforge.views.selection.Selection(request)

User selection management.

update()

Update the list of files of the user selection sorted by storage.

invalidate()

Invalidate the current selection if exists.

toggle_overview(storage_id)

Toggle overview for storage storage_id.

Parameters:storage_id – (string) Storage ID.

xhtml()

Return an <ul> structure or a <span> structure if empty.

add(paths)

Add files to the selection.

Parameters:paths – (list) List of files to add.

class publiforge.views.selection.SelectionView(request)

Class to manage user selection views.

remove()

Remove files from the user selection.

overview()

Toggle overview of files for the indicated storage.

add()

Add one file to the user selection with an AJAX request.

The views.group Module

Group view callables.

class publiforge.views.group.GroupView(request)

Class to manage groups.

admin()

List groups for administration purpose.

view()

Show group settings.

create()

Create a group.

edit()

Edit group settings.

The views.storage Module

Storage view callables.

class publiforge.views.storage.StorageView(request)

Class to manage storages.

admin()

List storages for administration purpose.

index()

List authorized storages.

view()

Show storage settings with its users and groups.

create()

Create a storage.

edit()

Edit storage settings.

browse()

Browse a storage.

The views.indexer Module

Indexer view callables.

class publiforge.views.indexer.IndexerView(request)

Class to manage indexers.

admin()

List indexers for administration purpose.

view()

Show indexer settings.

create()

Create an indexer.

edit()

Edit indexer settings.

The views.file Module

File view callables.

class publiforge.views.file.FileView(request)

Class to manage files in a storage.

search()

Search files in storages.

session['search'] is a dictionary with the following keys: scope, inputs, columns and result.

display()

Display content or rendering.

modify()

Modify file and save it.

auto_check()

Validate the current file, possibly save it, and continue.

media()

Return the URL of the searched media.

resources_dirs()

Return the list of resource directories.

resources_files()

Return the list of media files of a resource directory.

navigate()

Display the next or previous file of the same type in the same directory.

navigate_search()

Display the next or previous file in the search results.

info()

Show file information and VCS log.

download()

Download a file.

revision()

Retrieve a revision of a file.

diff()

Differences between a version and current version.

The views.project Module

Project view callables.

class publiforge.views.project.ProjectView(request)

Class to manage projects.

admin()

List projects for administration purpose.

index()

List authorized projects.

view()

Show project settings with its users.

create()

Create a project.

edit()

Edit project settings.

dashboard()

Display a project dashboard.

The views.processing Module

Processing view callables.

class publiforge.views.processing.ProcessingView(request)

Class to manage processings.

view()

Display processing settings.

create()

Create a processing.

edit()

Edit a processing.

The views.role Module

Role view callables.

class publiforge.views.role.RoleView(request)

Class to manage roles.

view()

Display role settings.

create()

Create a role.

edit()

Edit a role.

The views.task Module

Task view callables.

class publiforge.views.task.TaskView(request)

Class to manage tasks.

index()

List tasks to do.

view()

Display task settings.

create()

Create a task.

edit()

Edit a task.

The views.pack Module

Pack view callables.

class publiforge.views.pack.PackView(request)

Class to manage packs.

index()

List all packs of a project.

view()

Display a pack.

create()

Create a pack.

edit()

Edit a pack.

The views.site Module

Site view callables.

class publiforge.views.site.SiteView(request)

Class to manage global website.

admin()

List users, groups, storages, processors and projects and allow import/export operations.

The views.build Module

Build view callables.

class publiforge.views.build.BuildView(request)

Class to manage builds.

launch()

Launch one or more builds.

view()

Display a build, possibly, with its result.

progress()

Display the build progress.

complete()

Complete a build.

info()

Return information about a build (AJAX)

log()

Download current log.

results()

List all builds in progress or with result.

The views.maestro Module

These XML-RPC functions are called by Maestro client.

publiforge.views.maestro.storages(request, context, with_index=True)

Return a list of available storages.

Parameters:

• request – (pyramid.request.Request instance) Current request.
• context – (dictionary) A context for authentication.
• with_index – (boolean, default=True) If True select only storages with indexed files.

Returns:

(tuple) (error, result)

publiforge.views.maestro.indexes(request, context)

Return a list of available indexes.

Parameters:

• request – (pyramid.request.Request instance) Current request.
• context – (dictionary) A context for authentication.

Returns:

(tuple) (error, result)

publiforge.views.maestro.search(request, context, scope, query, limit)

Return the result of a search limited to limit lines.

Parameters:

• request – (pyramid.request.Request instance) Current request.
• context – (dictionary) A context for authentication.

Returns:

(tuple) (error, result)

publiforge.views.maestro.file_info(request, context, filename)

Return date and size of file filename.

Parameters:

• request – (pyramid.request.Request instance) Current request.
• context – (dictionary) A context for authentication.
• filename – (string) Relative path of file to search.

Returns:

(tuple) (error, result) where result is a tuple like (file_mtime, file_size).

publiforge.views.maestro.file_download(request, context, filename)

Download file filename.

Parameters:

• request – (pyramid.request.Request instance) Current request.
• context – (dictionary) A context for authentication.
• filename – (string) Relative path of file to search.

Returns:

(tuple) (error, result)

publiforge.views.maestro.pack_info(request, context, content, project_label)

Return date and size of all files of a pack.

Parameters:

• request – (pyramid.request.Request instance) Current request.
• context – (dictionary) A context for authentication.
• content – (xmlrpclib.Binary instance) Content of pack settings.
• project_label – (string) Label of the project to use.

Returns:

(tuple) (error, result) where result is a tuple like (pack_exists, info_list). info_list is a list such as [(file_path, file_mtime, file_size),...].

publiforge.views.maestro.pack_upload(request, context, content, project_label, message)

Upload a pack inot the project project.

Parameters:

• request – (pyramid.request.Request instance) Current request.
• context – (dictionary) A context for authentication.
• content – (xmlrpclib.Binary instance) Content of the pack.
• project_label – (string) Label of the project to use.
• message – (string) Message for commit operation.

Returns:

(tuple) (error, result)

publiforge.views.maestro.build(request, context, project_label, pack_label, processing_label)

Upload a pack inot the project project.

Parameters:

• request – (pyramid.request.Request instance) Current request.
• context – (dictionary) A context for authentication.
• project_label – (string) Label of the project to use.
• pack_label – (string) Label of the pack to use.
• processing_label – (string) Label of the processing to use.

Returns:

(tuple) (error, result)

publiforge.views.maestro.build_log(request, context, build_id)

Send log of build build_id.

Parameters:

• request – (pyramid.request.Request instance) Current request.
• context – (dictionary) A context for authentication.
• build_id – (string) ID of build to retrieve.

Returns:

(tuple) (error, result)

publiforge.views.maestro.results(request, context, project_label)

Upload a pack inot the project project.

Parameters:

• request – (pyramid.request.Request instance) Current request.
• context – (dictionary) A context for authentication.
• project_label – (string) Label of the project to use.

Returns:

(tuple) (error, (working, results))

publiforge.views.maestro.result_download(request, context, build_id)

Download result of build build_id.

Parameters:

• request – (pyramid.request.Request instance) Current request.
• context – (dictionary) A context for authentication.
• build_id – (string) ID of build to retrieve.

Returns:

(tuple) (error, result)