class NewCodeImportForm(Interface):
"""The fields presented on the form for editing a code import."""
use_template(IBranch, ['owner'])
use_template(ICodeImport, ['rcs_type', 'cvs_root', 'cvs_module'])
svn_branch_url = URIField(
title=_("Branch URL"), required=False,
description=_(
"The URL of a Subversion branch, starting with svn:// or "
"http(s)://. You can include a username and password as part "
"of the url, but this will be displayed on the branch page."),
allowed_schemes=["http", "https", "svn"],
allow_userinfo=True,
allow_port=True,
allow_query=False,
allow_fragment=False,
trailing_slash=False)
git_repo_url = URIField(
title=_("Repo URL"), required=False,
description=_(
"The URL of the git repository. The HEAD branch will be "
"imported."),
allowed_schemes=["git", "http", "https"],
allow_userinfo=True,
allow_port=True,
allow_query=False,
allow_fragment=False,
trailing_slash=False)
bzr_branch_url = URIField(
title=_("Branch URL"), required=False,
description=_("The URL of the Bazaar branch."),
allowed_schemes=["http", "https", "bzr", "ftp"],
allow_userinfo=True,
allow_port=True,
allow_query=False, # Query makes no sense in Bazaar
allow_fragment=False, # Fragment makes no sense in Bazaar
trailing_slash=False)
branch_name = copy_field(
IBranch['name'],
__name__='branch_name',
title=_('Branch Name'),
description=_(
"This will be used in the branch URL to identify the "
"imported branch. Examples: main, trunk."),
)
product = Choice(
title=_('Project'),
description=_("The Project to associate the code import with."),
vocabulary="Product",
)
def __init__(self, allow_external=False, **kwargs):
super(GitRepositoryField, self).__init__(**kwargs)
if allow_external:
self._uri_field = URIField(
__name__=self.__name__,
title=self.title,
allowed_schemes=["git", "http", "https"],
allow_userinfo=True,
allow_port=True,
allow_query=False,
allow_fragment=False,
trailing_slash=False)
else:
self._uri_field = None
class SetBranchForm(Interface):
"""The fields presented on the form for setting a branch."""
use_template(ICodeImport, ['cvs_module'])
rcs_type = Choice(title=_("Type of RCS"),
required=False, vocabulary=RevisionControlSystems,
description=_(
"The version control system to import from. "))
repo_url = URIField(
title=_("Branch URL"), required=True,
description=_("The URL of the branch."),
allowed_schemes=["http", "https"],
allow_userinfo=False, allow_port=True, allow_query=False,
allow_fragment=False, trailing_slash=False)
branch_location = copy_field(
IProductSeries['branch'], __name__='branch_location',
title=_('Branch'),
description=_(
"The Bazaar branch for this series in Launchpad, "
"if one exists."))
branch_type = Choice(
title=_('Import type'), vocabulary=BRANCH_TYPE_VOCABULARY,
description=_("The type of import"), required=True)
branch_name = copy_field(
IBranch['name'], __name__='branch_name', title=_('Branch name'),
description=_(''), required=True)
branch_owner = copy_field(
IBranch['owner'], __name__='branch_owner', title=_('Branch owner'),
description=_(''), required=True)
class BugWatchEditForm(Interface):
"""Form definition for the bug watch edit view."""
url = URIField(
title=_('URL'), required=True,
allowed_schemes=['http', 'https', 'mailto'],
description=_("The URL at which to view the remote bug, or the "
"email address to which this bug has been "
"forwarded (as a mailto: URL)."))
class BugWatchEditForm(Interface):
"""Form field definition for the bug watch widget.
Used to edit the bug watch on the bugtask edit page.
"""
url = URIField(
title=_('URL'),
required=True,
allowed_schemes=['http', 'https'],
description=_("""The URL at which to view the remote bug."""))
class GitRepositoryField(Choice):
"""A field identifying a Git repository.
This may always be set to the unique name of a Launchpad-hosted
repository. If `allow_external` is True, then it may also be set to a
valid external repository URL.
"""
def __init__(self, allow_external=False, **kwargs):
super(GitRepositoryField, self).__init__(**kwargs)
if allow_external:
self._uri_field = URIField(
__name__=self.__name__,
title=self.title,
allowed_schemes=["git", "http", "https"],
allow_userinfo=True,
allow_port=True,
allow_query=False,
allow_fragment=False,
trailing_slash=False)
else:
self._uri_field = None
def set(self, object, value):
if self._uri_field is not None and isinstance(value, six.string_types):
try:
self._uri_field.set(object, value)
return
except LaunchpadValidationError:
pass
super(GitRepositoryField, self).set(object, value)
def _validate(self, value):
if self._uri_field is not None and isinstance(value, six.string_types):
try:
self._uri_field._validate(value)
return
except LaunchpadValidationError:
pass
super(GitRepositoryField, self)._validate(value)
class IEditTranslator(Interface):
"""Set of translator attributes that the translator can edit themselves as
well as being editable by the translation group owner.
Translators can edit the data in their `ITranslator` entry.
Currently this is just the documentation URL.
"""
style_guide_url = URIField(
title=_('Translation guidelines'),
required=False,
allowed_schemes=['http', 'https', 'ftp'],
allow_userinfo=False,
description=_("The URL of the translation team guidelines "
"to be followed by this particular translation team. "
"Can be any of the http://, https://, or ftp:// links."))
class IWikiName(IHasOwner):
"""Wiki for Users"""
export_as_webservice_entry(publish_web_link=False)
id = Int(title=_("Database ID"), required=True, readonly=True)
# schema=Interface will be overridden in person.py because of circular
# dependencies.
person = exported(
Reference(
title=_("Owner"), schema=Interface, required=True, readonly=True))
wiki = exported(
URIField(title=_("Wiki host"),
allowed_schemes=['http', 'https'],
required=True))
wikiname = exported(
TextLine(title=_("Wikiname"), required=True))
url = exported(
TextLine(title=_("The URL for this wiki home page."), readonly=True))
def destroySelf():
"""Remove this WikiName from the database."""
class IProductView(
ICanGetMilestonesDirectly, IHasAppointedDriver, IHasBranches,
IHasExternalBugTracker,
IHasMergeProposals, IHasMilestones, IHasExpirableBugs,
IHasMugshot, IHasSprints, IHasTranslationImports,
ITranslationPolicy, IKarmaContext, IMakesAnnouncements,
IOfficialBugTagTargetPublic, IHasOOPSReferences,
IHasRecipes, IHasCodeImports, IServiceUsage, IHasGitRepositories):
"""Public IProduct properties."""
registrant = exported(
PublicPersonChoice(
title=_('Registrant'),
required=True,
readonly=True,
vocabulary='ValidPersonOrTeam',
description=_("This person registered the project in "
"Launchpad.")))
driver = exported(
PersonChoice(
title=_("Driver"),
description=_(
"This person or team will be able to set feature goals for "
"and approve bug targeting or backporting for ANY major "
"series in this project. You might want to leave this blank "
"and just appoint a team for each specific series, rather "
"than having one project team that does it all."),
required=False, vocabulary='ValidPersonOrTeam'))
summary = exported(
Summary(
title=_('Summary'),
description=_(
"A short paragraph to introduce the project's work.")))
description = exported(
Description(
title=_('Description'),
required=False,
description=_(
"Details about the project's work, highlights, goals, and "
"how to contribute. Use plain text, paragraphs are preserved "
"and URLs are linked in pages. Don't repeat the Summary.")))
datecreated = exported(
Datetime(
title=_('Date Created'),
required=True, readonly=True,
description=_("The date this project was created in Launchpad.")),
exported_as='date_created')
homepageurl = exported(
URIField(
title=_('Homepage URL'),
required=False,
allowed_schemes=['http', 'https', 'ftp'], allow_userinfo=False,
description=_("""The project home page. Please include
the http://""")),
exported_as="homepage_url")
wikiurl = exported(
URIField(
title=_('Wiki URL'),
required=False,
allowed_schemes=['http', 'https', 'ftp'], allow_userinfo=False,
description=_("""The full URL of this project's wiki, if it has
one. Please include the http://""")),
exported_as='wiki_url')
screenshotsurl = exported(
URIField(
title=_('Screenshots URL'),
required=False,
allowed_schemes=['http', 'https', 'ftp'], allow_userinfo=False,
description=_("""The full URL for screenshots of this project,
if available. Please include the http://""")),
exported_as='screenshots_url')
downloadurl = exported(
URIField(
title=_('Download URL'),
required=False,
allowed_schemes=['http', 'https', 'ftp'], allow_userinfo=False,
description=_("""The full URL where downloads for this project
are located, if available. Please include the http://""")),
exported_as='download_url')
programminglang = exported(
TextLine(
title=_('Programming Languages'),
required=False,
description=_("""A comma delimited list of programming
languages used for this project.""")),
exported_as='programming_language')
sourceforgeproject = exported(
TextLine(
title=_('Sourceforge Project'),
required=False,
constraint=sourceforge_project_name_validator,
description=_("""The SourceForge project name for
this project, if it is in sourceforge.""")),
exported_as='sourceforge_project')
freshmeatproject = exported(
TextLine(
title=_('Freshmeat Project'),
required=False, description=_("""The Freshmeat project name for
this project, if it is in freshmeat. [DEPRECATED]""")),
exported_as='freshmeat_project')
homepage_content = Text(
title=_("Homepage Content"), required=False,
description=_(
"The content of this project's home page. Edit this and it will "
"be displayed for all the world to see. It is NOT a wiki "
"so you cannot undo changes."))
mugshot = exported(
MugshotImageUpload(
title=_("Brand"), required=False,
default_image_resource='/@@/product-mugshot',
description=_(
"A large image of exactly 192x192 pixels, that will be "
"displayed on this project's home page in Launchpad. It "
"should be no bigger than 100kb in size.")),
exported_as='brand')
autoupdate = Bool(
title=_('Automatic update'),
description=_("Whether or not this project's attributes are "
"updated automatically."))
private_bugs = exported(
Bool(
title=_('Private bugs (obsolete; always False)'), readonly=True,
description=_("Replaced by bug_sharing_policy.")),
('devel', dict(exported=False)))
branch_sharing_policy = exported(Choice(
title=_('Branch sharing policy'),
description=_("Sharing policy for this project's branches."),
required=True, readonly=True, vocabulary=BranchSharingPolicy),
as_of='devel')
bug_sharing_policy = exported(Choice(
title=_('Bug sharing policy'),
description=_("Sharing policy for this project's bugs."),
required=True, readonly=True, vocabulary=BugSharingPolicy),
as_of='devel')
specification_sharing_policy = exported(Choice(
title=_('Blueprint sharing policy'),
description=_("Sharing policy for this project's specifications."),
required=True, readonly=True, vocabulary=SpecificationSharingPolicy),
as_of='devel')
licenses = exported(
Set(title=_('Licences'),
value_type=Choice(vocabulary=License)))
license_info = exported(
Description(
title=_('Description of additional licences'),
required=False,
description=_(
"Description of licences that do not appear in the list "
"above.")))
bugtracker = exported(
ProductBugTracker(
title=_('Bugs are tracked'),
vocabulary="BugTracker"),
exported_as='bug_tracker')
sourcepackages = Attribute(_("List of packages for this product"))
date_next_suggest_packaging = exported(
Datetime(
title=_('Next suggest packaging date'),
description=_(
"Obsolete. The date to resume Ubuntu package suggestions."),
required=False),
('devel', dict(exported=False)))
distrosourcepackages = Attribute(_("List of distribution packages for "
"this product"))
ubuntu_packages = Attribute(
_("List of distribution packages for this product in Ubuntu"))
series = exported(
doNotSnapshot(
CollectionField(value_type=Object(schema=IProductSeries))))
development_focus = exported(
ReferenceChoice(
title=_('Development focus'), required=True,
vocabulary='FilteredProductSeries',
schema=IProductSeries,
description=_(
'The series that represents the master or trunk branch. '
'The Bazaar URL lp:<project> points to the development focus '
'series branch.')))
development_focusID = Attribute("The development focus ID.")
releases = exported(
doNotSnapshot(
CollectionField(
title=_("An iterator over the ProductReleases for "
"this product."),
readonly=True,
value_type=Reference(schema=IProductRelease))))
translation_focus = exported(
ReferenceChoice(
title=_("Translation focus"), required=False,
vocabulary='FilteredProductSeries',
schema=IProductSeries,
description=_(
'Project series that translators should focus on.')))
translatable_packages = Attribute(
"A list of the source packages for this product that can be "
"translated sorted by distroseries.name and sourcepackage.name.")
translatable_series = Attribute(
"A list of the series of this product for which we have translation "
"templates.")
obsolete_translatable_series = Attribute("""
A list of the series of this product with obsolete translation
templates.""")
primary_translatable = Attribute(
"The best guess we have for what new translators will want to "
"translate for a given product: the latest series for which we have "
"templates, and failing that, an Ubuntu package.")
translationgroups = Attribute("The list of applicable translation "
"groups for a product. There can be several: one from the product, "
"and potentially one from the project, too.")
commercial_subscription = exported(
Reference(
ICommercialSubscription,
title=_("Commercial subscriptions"),
description=_(
"An object which contains the timeframe and the voucher "
"code of a subscription.")))
commercial_subscription_is_due = exported(
Bool(
title=_("Commercial subscription is due"),
readonly=True,
description=_(
"Whether the project's licensing requires a new "
"commercial subscription to use launchpad.")))
has_current_commercial_subscription = Attribute("""
Whether the project has a current commercial subscription.""")
license_status = Attribute("""
Whether the licence is OPENSOURCE, UNREVIEWED, or PROPRIETARY.""")
remote_product = exported(
TextLine(
title=_('Remote bug tracker project id'), required=False,
description=_(
"Some bug trackers host multiple projects at the same URL "
"and require an identifier for the specific project.")))
active_or_packaged_series = Attribute(
_("Series that are active and/or have been packaged."))
packagings = Attribute(_("All the packagings for the project."))
security_contact = exported(
TextLine(
title=_('Security contact'), required=False, readonly=True,
description=_('Security contact (obsolete; always None)')),
('devel', dict(exported=False)), as_of='1.0')
vcs = exported(
Choice(
title=_("VCS"),
required=False,
vocabulary=VCSType,
description=_(
"Version control system for this project's code.")))
inferred_vcs = Choice(
title=_("Inferred VCS"),
readonly=True,
vocabulary=VCSType,
description=_(
"Inferred version control system for this project's code."))
def getAllowedBugInformationTypes():
"""Get the information types that a bug in this project can have.
:return: A sequence of `InformationType`s.
"""
def getDefaultBugInformationType():
"""Get the default information type of a new bug in this project.
:return: The `InformationType`.
"""
def getVersionSortedSeries(statuses=None, filter_statuses=None):
"""Return all the series sorted by the name field as a version.
The development focus field is an exception. It will always
be sorted first.
:param statuses: If statuses is not None, only include series
which are in the given statuses.
:param filter_statuses: Filter out any series with statuses listed in
filter_statuses.
"""
def redeemSubscriptionVoucher(voucher, registrant, purchaser,
subscription_months, whiteboard=None,
current_datetime=None):
"""Redeem a voucher and extend the subscription expiration date.
The voucher must have already been verified to be redeemable.
:param voucher: The voucher id as tracked in the external system.
:param registrant: Who is redeeming the voucher.
:param purchaser: Who purchased the voucher. May not be known.
:param subscription_months: integer indicating the number of months
the voucher is for.
:param whiteboard: Notes for this activity.
:param current_datetime: Current time. Will be datetime.now() if not
specified.
:return: None
"""
def getPackage(distroseries):
"""Return a package in that distroseries for this product."""
@operation_parameters(
name=TextLine(title=_("Name"), required=True))
@operation_returns_entry(IProductSeries)
@export_read_operation()
def getSeries(name):
"""Return the series for this product for the given name, or None."""
@operation_parameters(
version=TextLine(title=_("Version"), required=True))
@operation_returns_entry(IProductRelease)
@export_read_operation()
def getRelease(version):
"""Return the release for this product that has the version given."""
def getMilestonesAndReleases():
"""Return all the milestones and releases for this product."""
def packagedInDistros():
"""Returns the distributions this product has been packaged in."""
def userCanEdit(user):
"""Can the user edit this product?"""
def getLinkedBugWatches():
"""Return all the bug watches that are linked to this Product.
Being linked, means that a bug watch having the same bug tracker
as this Product is using, is linked to a bug task targeted to
this Product.
"""
@operation_parameters(
include_inactive=Bool(title=_("Include inactive"),
required=False, default=False))
@export_read_operation()
@export_operation_as('get_timeline')
def getTimeline(include_inactive):
"""Return basic timeline data useful for creating a diagram.
class IWebhook(Interface):
export_as_webservice_entry(as_of='beta')
id = Int(title=_("ID"), readonly=True, required=True)
target = exported(
Reference(
title=_("Target"),
schema=Interface, # Actually IWebhookTarget.
required=True,
readonly=True,
description=_(
"The object for which this webhook receives events.")))
event_types = exported(
List(Choice(vocabulary='ValidWebhookEventType'),
title=_("Event types"),
required=True,
readonly=False))
registrant = exported(
Reference(title=_("Registrant"),
schema=IPerson,
required=True,
readonly=True,
description=_("The person who created this webhook.")))
registrant_id = Int(title=_("Registrant ID"))
date_created = exported(
Datetime(title=_("Date created"), required=True, readonly=True))
date_last_modified = exported(
Datetime(title=_("Date last modified"), required=True, readonly=True))
delivery_url = exported(
URIField(title=_("Delivery URL"),
allowed_schemes=['http', 'https'],
required=True,
readonly=False))
active = exported(
Bool(title=_("Active"),
description=_("Deliver details of subscribed events."),
required=True,
readonly=False))
# Do not export this.
secret = TextLine(
title=_("Secret"),
required=False,
description=_(
"An optional string used to sign delivery bodies with HMAC-SHA1 "
"in the X-Hub-Signature header. This must be less than 200 bytes "
"long."),
max_length=200)
deliveries = exported(
doNotSnapshot(
CollectionField(title=_("Recent deliveries for this webhook."),
value_type=Reference(schema=Interface),
readonly=True)))
def getDelivery(id):
"""Retrieve a delivery by ID, or None if it doesn't exist."""
@export_factory_operation(Interface, []) # Actually IWebhookDelivery.
@operation_for_version('devel')
def ping():
"""Send a test event."""
@export_destructor_operation()
@operation_for_version('devel')
def destroySelf():
"""Delete this webhook."""
@export_write_operation()
@operation_parameters(secret=copy_field(secret))
@operation_for_version('devel')
def setSecret(secret):
"""Set the secret used to sign deliveries."""
class ITranslationGroup(IHasOwner):
"""A TranslationGroup."""
export_as_webservice_entry(
singular_name='translation_group', plural_name='translation_groups')
id = Int(
title=_('Translation Group ID'), required=True, readonly=True,
)
name = exported(
TextLine(
title=_('Name'), required=True,
description=_("""Keep this name very short, unique, and
descriptive, because it will be used in URLs. Examples:
gnome-translation-project, ubuntu-translators."""),
constraint=name_validator),
as_of="devel"
)
title = exported(
Title(
title=_('Title'), required=True,
description=_("""Title of this Translation Group.
This title is displayed at the top of the Translation Group
page and in lists or reports of translation groups. Do not
add "translation group" to this title, or it will be shown
double.
"""),),
as_of="devel"
)
summary = Summary(
title=_('Summary'), required=True,
description=_("""A single-paragraph description of the
group. This will also be displayed in most
translation group listings."""),
)
datecreated = Datetime(
title=_('Date Created'), required=True, readonly=True,
)
owner = PublicPersonChoice(
title=_('Owner'), required=True, vocabulary='ValidOwner',
description=_("The owner's IPerson"))
# joins
translators = Attribute('The set of translators for this group.')
projects = Attribute('The projects for which this group translates.')
products = Attribute('The projects to which this group is directly '
'appointed as a translator. There may be other projects that are '
'part of project groups for which the group also translates.')
distributions = Attribute('The distros for which this group translates.')
translation_guide_url = URIField(
title=_('Translation instructions'), required=False,
allowed_schemes=['http', 'https', 'ftp'],
allow_userinfo=False,
description=_("The URL of the generic translation instructions "
"followed by this particular translation group. "
"This should include team policies and "
"recommendations, specific instructions for "
"any non-standard behaviour and other documentation."
"Can be any of http://, https://, or ftp://."))
# accessing the translator list
def query_translator(language):
"""Retrieve a translator, or None, based on a Language"""
# adding and removing translators
def remove_translator(language):
"""Remove the translator for this language from the group."""
# used for the form machinery
def add(content):
"""Add a new object."""
top_projects = Attribute(
"Most relevant projects using this translation group.")
number_of_remaining_projects = Attribute(
"Count of remaining projects not listed in the `top_projects`.")
def __getitem__(language_code):
"""Retrieve the translator for the given language in this group.
This is used for navigation through the group.
"""
def fetchTranslatorData():
"""Fetch translators and related data.
Prefetches display-related properties.
:return: A result set of (`Translator`, `Language`, `Person`),
ordered by language name in English.
"""
def fetchProjectsForDisplay(user):
"""Fetch `Product`s using this group, for display purposes.
Prefetches display-related properties.
:return: A result set of `Product`, ordered by display name.
"""
def fetchProjectGroupsForDisplay():
"""Fetch `Project`s using this group, for display purposes.
Prefetches display-related properties.
:return: A result set of `Project`, ordered by display name.
"""
def fetchDistrosForDisplay():
"""Fetch `Distribution`s using this group, for display purposes.
class ICodeImport(Interface):
"""A code import to a Bazaar Branch."""
export_as_webservice_entry()
id = Int(readonly=True, required=True)
date_created = Datetime(title=_("Date Created"),
required=True,
readonly=True)
branch = exported(
ReferenceChoice(title=_('Branch'),
required=True,
readonly=True,
vocabulary='Branch',
schema=IBranch,
description=_("The Bazaar branch produced by the "
"import system.")))
registrant = PublicPersonChoice(
title=_('Registrant'),
required=True,
readonly=True,
vocabulary='ValidPersonOrTeam',
description=_("The person who initially requested this import."))
review_status = exported(
Choice(title=_("Review Status"),
vocabulary=CodeImportReviewStatus,
default=CodeImportReviewStatus.REVIEWED,
readonly=True,
description=_("Only reviewed imports are processed.")))
rcs_type = exported(
Choice(title=_("Type of RCS"),
readonly=True,
required=True,
vocabulary=RevisionControlSystems,
description=_("The version control system to import from. "
"Can be CVS or Subversion.")))
url = exported(
URIField(
title=_("URL"),
required=False,
readonly=True,
description=_("The URL of the VCS branch."),
allowed_schemes=["http", "https", "svn", "git", "bzr", "ftp"],
allow_userinfo=True,
allow_port=True,
allow_query=False, # Query makes no sense in Subversion.
allow_fragment=False, # Fragment makes no sense in Subversion.
trailing_slash=False)) # See http://launchpad.net/bugs/56357.
cvs_root = exported(
TextLine(
title=_("Repository"),
required=False,
readonly=True,
constraint=validate_cvs_root,
description=_(
"The CVSROOT. "
"Example: :pserver:[email protected]:/cvs/gnome")))
cvs_module = exported(
TextLine(title=_("Module"),
required=False,
readonly=True,
constraint=validate_cvs_module,
description=_("The path to import within the repository."
" Usually, it is the name of the project.")))
date_last_successful = exported(
Datetime(title=_("Last successful"), required=False, readonly=True))
update_interval = Timedelta(
title=_("Update interval"),
required=False,
description=
_("The user-specified time between automatic updates of this import. "
"If this is unspecified, the effective update interval is a default "
"value selected by Launchpad administrators."))
effective_update_interval = Timedelta(
title=_("Effective update interval"),
required=True,
readonly=True,
description=_(
"The effective time between automatic updates of this import. "
"If the user did not specify an update interval, this is a default "
"value selected by Launchpad administrators."))
def getImportDetailsForDisplay():
"""Get a one-line summary of the location this import is from."""
import_job = Choice(
title=_("Current job"),
readonly=True,
vocabulary='CodeImportJob',
description=_(
"The current job for this import, either pending or running."))
results = Attribute("The results for this code import.")
consecutive_failure_count = Attribute(
"How many times in a row this import has failed.")
def updateFromData(data, user):
"""Modify attributes of the `CodeImport`.
Creates and returns a MODIFY `CodeImportEvent` if changes were made.
This method preserves the invariant that a `CodeImportJob` exists for
a given import if and only if its review_status is REVIEWED, creating
and deleting jobs as necessary.
:param data: dictionary whose keys are attribute names and values are
attribute values.
:param user: user who made the change, to record in the
`CodeImportEvent`. May be ``None``.
:return: The MODIFY `CodeImportEvent`, if any changes were made, or
None if no changes were made.
"""
def tryFailingImportAgain(user):
"""Try a failing import again.
This method sets the review_status back to REVIEWED and requests the
import be attempted as soon as possible.
The import must be in the FAILING state.
:param user: the user who is requesting the import be tried again.
"""
@call_with(requester=REQUEST_USER)
@export_write_operation()
def requestImport(requester, error_if_already_requested=False):
"""Request that an import be tried soon.
class ISnapEditableAttributes(IHasOwner):
"""`ISnap` attributes that can be edited.
These attributes need launchpad.View to see, and launchpad.Edit to change.
"""
date_last_modified = exported(Datetime(
title=_("Date last modified"), required=True, readonly=True))
owner = exported(PersonChoice(
title=_("Owner"), required=True, readonly=False,
vocabulary="AllUserTeamsParticipationPlusSelf",
description=_("The owner of this snap package.")))
distro_series = exported(Reference(
IDistroSeries, title=_("Distro Series"),
required=False, readonly=False,
description=_(
"The series for which the snap package should be built. If not "
"set, Launchpad will infer an appropriate series from "
"snapcraft.yaml.")))
name = exported(TextLine(
title=_("Name"), required=True, readonly=False,
constraint=name_validator,
description=_("The name of the snap package.")))
description = exported(Text(
title=_("Description"), required=False, readonly=False,
description=_("A description of the snap package.")))
branch = exported(ReferenceChoice(
title=_("Bazaar branch"), schema=IBranch, vocabulary="Branch",
required=False, readonly=False,
description=_(
"A Bazaar branch containing a snap/snapcraft.yaml, "
"build-aux/snap/snapcraft.yaml, snapcraft.yaml, or "
".snapcraft.yaml recipe at the top level.")))
git_repository = exported(ReferenceChoice(
title=_("Git repository"),
schema=IGitRepository, vocabulary="GitRepository",
required=False, readonly=True,
description=_(
"A Git repository with a branch containing a snap/snapcraft.yaml, "
"build-aux/snap/snapcraft.yaml, snapcraft.yaml, or "
".snapcraft.yaml recipe at the top level.")))
git_repository_url = exported(URIField(
title=_("Git repository URL"), required=False, readonly=True,
description=_(
"The URL of a Git repository with a branch containing a "
"snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, "
"snapcraft.yaml, or .snapcraft.yaml recipe at the top level."),
allowed_schemes=["git", "http", "https"],
allow_userinfo=True,
allow_port=True,
allow_query=False,
allow_fragment=False,
trailing_slash=False))
git_path = TextLine(
title=_("Git branch path"), required=False, readonly=False,
description=_(
"The path of the Git branch containing a snap/snapcraft.yaml, "
"build-aux/snap/snapcraft.yaml, snapcraft.yaml, or "
".snapcraft.yaml recipe at the top level."))
_api_git_path = exported(
TextLine(
title=git_path.title, required=False, readonly=False,
description=git_path.description),
exported_as="git_path")
git_ref = exported(Reference(
IGitRef, title=_("Git branch"), required=False, readonly=False,
description=_(
"The Git branch containing a snap/snapcraft.yaml, "
"build-aux/snap/snapcraft.yaml, snapcraft.yaml, or "
".snapcraft.yaml recipe at the top level.")))
build_source_tarball = exported(Bool(
title=_("Build source tarball"),
required=True, readonly=False,
description=_(
"Whether builds of this snap package should also build a tarball "
"containing all source code, including external dependencies.")))
auto_build = exported(Bool(
title=_("Automatically build when branch changes"),
required=True, readonly=False,
description=_(
"Whether this snap package is built automatically when the branch "
"containing its snap/snapcraft.yaml, "
"build-aux/snap/snapcraft.yaml, snapcraft.yaml, or "
".snapcraft.yaml recipe changes.")))
auto_build_archive = exported(Reference(
IArchive, title=_("Source archive for automatic builds"),
required=False, readonly=False,
description=_(
"The archive from which automatic builds of this snap package "
"should be built.")))
auto_build_pocket = exported(Choice(
title=_("Pocket for automatic builds"),
vocabulary=PackagePublishingPocket, required=False, readonly=False,
description=_(
"The package stream within the source distribution series to use "
"when building the snap package.")))
auto_build_channels = exported(Dict(
title=_("Source snap channels for automatic builds"),
key_type=TextLine(), required=False, readonly=False,
description=_(
"A dictionary mapping snap names to channels to use when building "
"this snap package. Currently only 'core' and 'snapcraft' keys "
"are supported.")))
is_stale = Bool(
title=_("Snap package is stale and is due to be rebuilt."),
required=True, readonly=False)
store_upload = exported(Bool(
title=_("Automatically upload to store"),
required=True, readonly=False,
description=_(
"Whether builds of this snap package are automatically uploaded "
"to the store.")))
# XXX cjwatson 2016-12-08: We should limit this to series that are
# compatible with distro_series, but that entails validating the case
# where both are changed in a single PATCH request in such a way that
# neither is compatible with the old value of the other. As far as I
# can tell lazr.restful only supports per-field validation.
store_series = exported(ReferenceChoice(
title=_("Store series"),
schema=ISnappySeries, vocabulary="SnappySeries",
required=False, readonly=False,
description=_(
"The series in which this snap package should be published in the "
"store.")))
store_distro_series = ReferenceChoice(
title=_("Store and distro series"),
schema=ISnappyDistroSeries, vocabulary="SnappyDistroSeries",
required=False, readonly=False)
store_name = exported(TextLine(
title=_("Registered store package name"),
required=False, readonly=False,
description=_(
"The registered name of this snap package in the store.")))
store_secrets = List(
value_type=TextLine(), title=_("Store upload tokens"),
required=False, readonly=False,
description=_(
"Serialized secrets issued by the store and the login service to "
"authorize uploads of this snap package."))
store_channels = exported(List(
title=_("Store channels"),
required=False, readonly=False, constraint=channels_validator,
description=_(
"Channels to release this snap package to after uploading it to "
"the store. A channel is defined by a combination of an optional "
" track, a risk, and an optional branch, e.g. "
"'2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or "
"'stable'.")))
class IProjectGroupPublic(ICanGetMilestonesDirectly, IHasAppointedDriver,
IHasBranches, IHasBugs, IHasDrivers, IHasIcon,
IHasLogo, IHasMergeProposals, IHasMilestones,
IHasMugshot, IHasOwner, IHasSpecifications,
IHasSprints, IMakesAnnouncements, IKarmaContext,
IHasOfficialBugTags, IServiceUsage):
"""Public IProjectGroup properties."""
id = Int(title=_('ID'), readonly=True)
# The following milestone collections are copied from IHasMilestone so that
# we can override the collection value types to be IProjectGroupMilestone.
milestones = copy_field(
IHasMilestones['milestones'],
value_type=Reference(schema=IProjectGroupMilestone))
all_milestones = copy_field(
IHasMilestones['all_milestones'],
value_type=Reference(schema=IProjectGroupMilestone))
owner = exported(
PublicPersonChoice(
title=_('Maintainer'),
required=True,
vocabulary='ValidPillarOwner',
description=_("The restricted team, moderated team, or person "
"who maintains the project group information in "
"Launchpad.")))
registrant = exported(
PublicPersonChoice(title=_('Registrant'),
required=True,
readonly=True,
vocabulary='ValidPersonOrTeam',
description=_(
"Project group registrant. Must be a valid "
"Launchpad Person.")))
display_name = exported(
TextLine(title=_('Display Name'),
description=_(
"Appropriately capitalised, "
'and typically ending in "Project". '
"Examples: the Apache Project, the Mozilla Project, "
"the Gimp Project.")))
displayname = Attribute('Display name (deprecated)')
title = exported(
Title(title=_('Title'),
description=_("The full name of the project group, "
"which can contain spaces, special characters, "
"etc.")))
summary = exported(
Summary(
title=_('Project Group Summary'),
description=_(
"A short paragraph to introduce the project group's work.")))
description = exported(
Text(title=_('Description'),
description=_(
"Details about the project group's work, goals, and "
"how to contribute. Use plain text, paragraphs are preserved "
"and URLs are linked in pages. Don't repeat the Summary.")))
datecreated = exported(Datetime(
title=_('Date Created'),
description=_("The date this project group was created in Launchpad."),
readonly=True),
exported_as="date_created")
driver = exported(
PublicPersonChoice(
title=_("Driver"),
description=_(
"This is a project group-wide appointment. Think carefully "
"here! This person or team will be able to set feature goals "
"and approve bug targeting and backporting for ANY series in "
"ANY project in this group. You can also appoint drivers "
"at the level of a specific project or series. So you may "
"just want to leave this space blank, and instead let the "
"individual projects and series have drivers."),
required=False,
vocabulary='ValidPersonOrTeam'))
homepageurl = exported(URIField(title=_('Homepage URL'),
required=False,
allowed_schemes=['http', 'https', 'ftp'],
allow_userinfo=False,
description=_(
"The project group home page. "
"Please include the http://")),
exported_as="homepage_url")
wikiurl = exported(URIField(
title=_('Wiki URL'),
required=False,
allowed_schemes=['http', 'https', 'ftp'],
allow_userinfo=False,
description=_("The URL of this project group's wiki, "
"if it has one. Please include the http://")),
exported_as="wiki_url")
lastdoap = TextLine(title=_('Last-parsed RDF fragment'),
description=_("The last RDF fragment for this "
"entity that we received and parsed, or "
"generated."),
required=False)
sourceforgeproject = exported(TextLine(
title=_("SourceForge Project Name"),
description=_("The SourceForge project name for this "
"project group, if it is in SourceForge."),
required=False),
exported_as="sourceforge_project")
freshmeatproject = exported(TextLine(
title=_("Freshmeat Project Name"),
description=_("The Freshmeat project name for this "
"project group, if it is in Freshmeat. "
"[DEPRECATED]"),
required=False),
exported_as="freshmeat_project")
homepage_content = exported(
Text(title=_("Homepage Content"),
required=False,
description=_(
"The content of this project group's home page. Edit this "
"and it will be displayed for all the world to see. It is "
"NOT a wiki so you cannot undo changes.")))
icon = exported(
IconImageUpload(
title=_("Icon"),
required=False,
default_image_resource='/@@/project',
description=_(
"A small image of exactly 14x14 pixels and at most 5kb in "
"size, that can be used to identify this project group. The "
"icon will be displayed in Launchpad everywhere that we link "
"to this project group. For example in listings or tables of "
"active project groups.")))
logo = exported(
LogoImageUpload(
title=_("Logo"),
required=False,
default_image_resource='/@@/project-logo',
description=_(
"An image of exactly 64x64 pixels that will be displayed in "
"the heading of all pages related to this project group. It "
"should be no bigger than 50kb in size.")))
mugshot = exported(
MugshotImageUpload(
title=_("Brand"),
required=False,
default_image_resource='/@@/project-mugshot',
description=_(
"A large image of exactly 192x192 pixels, that will be "
"displayed on this project group's home page in Launchpad. "
"It should be no bigger than 100kb in size. ")))
bugtracker = exported(ReferenceChoice(
title=_('Bug Tracker'),
required=False,
vocabulary='BugTracker',
schema=IBugTracker,
description=_(
"The bug tracker the projects in this project group use.")),
exported_as="bug_tracker")
# products.value_type will be set to IProduct once IProduct is defined.
products = exported(CollectionField(
title=_('List of active projects for this project group.'),
value_type=Reference(Interface)),
exported_as="projects")
bug_reporting_guidelines = exported(
Text(title=(u"If I\N{right single quotation mark}m reporting a bug, "
u"I should include, if possible"),
description=(u"These guidelines will be shown to "
"anyone reporting a bug."),
required=False,
max_length=50000))
bug_reported_acknowledgement = exported(
Text(title=(u"After reporting a bug, I can expect the following."),
description=(u"This message of acknowledgement will be displayed "
"to anyone after reporting a bug."),
required=False,
max_length=50000))
enable_bugfiling_duplicate_search = Bool(
title=u"Search for possible duplicate bugs when a new bug is filed",
required=False,
readonly=True)
translatables = Attribute("Products that are translatable in LP")
def getProduct(name):
"""Get a product with name `name`."""
def getConfigurableProducts():
"""Get all products that can be edited by user."""
def has_translatable():
"""Return a boolean showing the existance of translatables products.
"""
def has_branches():
"""Return a boolean showing the existance of products with branches.
"""
def hasProducts():
"""Returns True if a project has products associated with it, False
otherwise.
"""
def getSeries(series_name):
"""Return a ProjectGroupSeries object with name `series_name`."""
product_milestones = Attribute('all the milestones for all the products.')
