b4b7182960
* Remove callbacks in Collection object Make Collection a "dumb" object (and also a base object, though it isn't very useful for now) * Rename Path to WorkingPath, because it is more about managing state than being a single path. * Rewrite almost all WorkingPath, because the code was overly complicated for no reason (I tried some special cases and it turned out that fromstring didn't handle them, and that the quote-escape-unquote was just unecessary). I also rewrote it to be more pythonic (no more lambdas and maps) and added tests. * Require the full split path when creating a Collection. Because, come to think of it, an object needs an unique identifier; in the case of Collections, it is the full path, not only its last part. I might even replace the id by the full split path in the future. * There is now only one way to get items of a Collection: calling iter_resources(). * Rewrite flatten_resources to iter_resources_flat(), which just calls iter_resources() recursively. * Rewrite the collection part of the canalplus module. There is no more callback or a page calling the browser to check another page! The logic is only in iter_resources(). The resulting code is not very pretty, but it should get better. As a bonus, avoid to reload the main XML file when we already have it open. * change_path() now expects a split path and not a string. * up/home special cases for "cd" are handled in the same place, and store the previous place properly (but are not yet exploitable by an user command). This is a big commit but it would be hard to split it in *working* commits. If you read this entire commit message, I will buy you a beer. refs #774 fixes #773
286 lines
9.9 KiB
Python
286 lines
9.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright(C) 2010-2011 Romain Bignon
|
|
#
|
|
# This file is part of weboob.
|
|
#
|
|
# weboob is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# weboob is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with weboob. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
from __future__ import with_statement
|
|
|
|
from weboob.capabilities.content import ICapContent, Content
|
|
from weboob.capabilities.bugtracker import ICapBugTracker, Issue, Project, User, \
|
|
Version, Status, Update, Attachment, \
|
|
Query, Change
|
|
from weboob.capabilities.collection import ICapCollection, Collection, CollectionNotFound
|
|
from weboob.tools.backend import BaseBackend, BackendConfig
|
|
from weboob.tools.browser import BrowserHTTPNotFound
|
|
from weboob.tools.value import ValueBackendPassword, Value
|
|
|
|
from .browser import RedmineBrowser
|
|
|
|
|
|
__all__ = ['RedmineBackend']
|
|
|
|
|
|
class RedmineBackend(BaseBackend, ICapContent, ICapBugTracker, ICapCollection):
|
|
NAME = 'redmine'
|
|
MAINTAINER = 'Romain Bignon'
|
|
EMAIL = 'romain@weboob.org'
|
|
VERSION = '0.b'
|
|
DESCRIPTION = 'The Redmine project management web application'
|
|
LICENSE = 'AGPLv3+'
|
|
CONFIG = BackendConfig(Value('url', label='URL of the Redmine website', regexp=r'https?://.*'),
|
|
Value('username', label='Login'),
|
|
ValueBackendPassword('password', label='Password'))
|
|
BROWSER = RedmineBrowser
|
|
|
|
def create_default_browser(self):
|
|
return self.create_browser(self.config['url'].get(),
|
|
self.config['username'].get(),
|
|
self.config['password'].get())
|
|
|
|
############# CapContent ######################################################
|
|
|
|
def id2path(self, id):
|
|
return id.split('/', 2)
|
|
|
|
def get_content(self, id):
|
|
if isinstance(id, basestring):
|
|
content = Content(id)
|
|
else:
|
|
content = id
|
|
id = content.id
|
|
|
|
try:
|
|
_type, project, page = self.id2path(id)
|
|
except ValueError:
|
|
return None
|
|
|
|
with self.browser:
|
|
data = self.browser.get_wiki_source(project, page)
|
|
|
|
content.content = data
|
|
return content
|
|
|
|
def push_content(self, content, message=None, minor=False):
|
|
try:
|
|
_type, project, page = self.id2path(content.id)
|
|
except ValueError:
|
|
return
|
|
|
|
with self.browser:
|
|
return self.browser.set_wiki_source(project, page, content.content, message)
|
|
|
|
def get_content_preview(self, content):
|
|
try:
|
|
_type, project, page = self.id2path(content.id)
|
|
except ValueError:
|
|
return
|
|
|
|
with self.browser:
|
|
return self.browser.get_wiki_preview(project, page, content.content)
|
|
|
|
############# CapCollection ###################################################
|
|
def iter_resources(self, objs, split_path):
|
|
if Project in objs or Issue in objs:
|
|
if len(split_path) == 0:
|
|
return [Collection([project.id], project.name)
|
|
for project in self.iter_projects()]
|
|
|
|
if len(split_path) == 1:
|
|
query = Query()
|
|
query.project = unicode(split_path[0])
|
|
return self.iter_issues(query)
|
|
|
|
raise CollectionNotFound(split_path)
|
|
|
|
|
|
############# CapBugTracker ###################################################
|
|
def _build_project(self, project_dict):
|
|
project = Project(project_dict['name'], project_dict['name'])
|
|
project.members = [User(int(u[0]), u[1]) for u in project_dict['members']]
|
|
project.versions = [Version(int(v[0]), v[1]) for v in project_dict['versions']]
|
|
project.categories = [c[1] for c in project_dict['categories']]
|
|
# TODO set the value of status
|
|
project.statuses = [Status(int(s[0]), s[1], 0) for s in project_dict['statuses']]
|
|
return project
|
|
|
|
def iter_issues(self, query):
|
|
"""
|
|
Iter issues with optionnal patterns.
|
|
|
|
@param query [Query]
|
|
@return [iter(Issue)] issues
|
|
"""
|
|
# TODO link between text and IDs.
|
|
kwargs = {'subject': query.title,
|
|
'author_id': query.author,
|
|
'assigned_to_id': query.assignee,
|
|
'fixed_version_id': query.version,
|
|
'category_id': query.category,
|
|
'status_id': query.status,
|
|
}
|
|
r = self.browser.query_issues(query.project, **kwargs)
|
|
project = self._build_project(r['project'])
|
|
for issue in r['iter']:
|
|
obj = Issue(issue['id'])
|
|
obj.project = project
|
|
obj.title = issue['subject']
|
|
obj.creation = issue['created_on']
|
|
obj.updated = issue['updated_on']
|
|
|
|
if isinstance(issue['author'], tuple):
|
|
obj.author = project.find_user(*issue['author'])
|
|
else:
|
|
obj.author = User(0, issue['author'])
|
|
if isinstance(issue['assigned_to'], tuple):
|
|
obj.assignee = project.find_user(*issue['assigned_to'])
|
|
else:
|
|
obj.assignee = issue['assigned_to']
|
|
|
|
obj.category = issue['category']
|
|
|
|
if issue['fixed_version'] is not None:
|
|
obj.version = project.find_version(*issue['fixed_version'])
|
|
else:
|
|
obj.version = None
|
|
obj.status = project.find_status(issue['status'])
|
|
yield obj
|
|
|
|
def get_issue(self, issue):
|
|
if isinstance(issue, Issue):
|
|
id = issue.id
|
|
else:
|
|
id = issue
|
|
issue = Issue(issue)
|
|
|
|
try:
|
|
with self.browser:
|
|
params = self.browser.get_issue(id)
|
|
except BrowserHTTPNotFound:
|
|
return None
|
|
|
|
issue.project = self._build_project(params['project'])
|
|
issue.title = params['subject']
|
|
issue.body = params['body']
|
|
issue.creation = params['created_on']
|
|
issue.updated = params['updated_on']
|
|
issue.attachments = []
|
|
for a in params['attachments']:
|
|
attachment = Attachment(a['id'])
|
|
attachment.filename = a['filename']
|
|
attachment.url = a['url']
|
|
issue.attachments.append(attachment)
|
|
issue.history = []
|
|
for u in params['updates']:
|
|
update = Update(u['id'])
|
|
update.author = issue.project.find_user(*u['author'])
|
|
update.date = u['date']
|
|
update.message = u['message']
|
|
update.changes = []
|
|
for i, (field, last, new) in enumerate(u['changes']):
|
|
change = Change(i)
|
|
change.field = field
|
|
change.last = last
|
|
change.new = new
|
|
update.changes.append(change)
|
|
issue.history.append(update)
|
|
issue.author = issue.project.find_user(*params['author'])
|
|
issue.assignee = issue.project.find_user(*params['assignee'])
|
|
issue.category = params['category'][1]
|
|
issue.version = issue.project.find_version(*params['version'])
|
|
issue.status = issue.project.find_status(params['status'][1])
|
|
|
|
return issue
|
|
|
|
def create_issue(self, project):
|
|
try:
|
|
with self.browser:
|
|
r = self.browser.query_issues(project)
|
|
except BrowserHTTPNotFound:
|
|
return None
|
|
|
|
issue = Issue(0)
|
|
issue.project = self._build_project(r['project'])
|
|
return issue
|
|
|
|
def post_issue(self, issue):
|
|
project = issue.project.id
|
|
|
|
kwargs = {'title': issue.title,
|
|
'version': issue.version.id if issue.version else None,
|
|
'assignee': issue.assignee.id if issue.assignee else None,
|
|
'category': issue.category,
|
|
'status': issue.status.id if issue.status else None,
|
|
'body': issue.body,
|
|
}
|
|
|
|
with self.browser:
|
|
if int(issue.id) < 1:
|
|
id = self.browser.create_issue(project, **kwargs)
|
|
else:
|
|
id = self.browser.edit_issue(issue.id, **kwargs)
|
|
|
|
if id is None:
|
|
return None
|
|
|
|
issue.id = id
|
|
return issue
|
|
|
|
def update_issue(self, issue, update):
|
|
if isinstance(issue, Issue):
|
|
issue = issue.id
|
|
|
|
with self.browser:
|
|
if update.hours:
|
|
return self.browser.logtime_issue(issue, update.hours, update.message)
|
|
else:
|
|
return self.browser.comment_issue(issue, update.message)
|
|
|
|
def remove_issue(self, issue):
|
|
"""
|
|
Remove an issue.
|
|
"""
|
|
if isinstance(issue, Issue):
|
|
issue = issue.id
|
|
|
|
with self.browser:
|
|
return self.browser.remove_issue(issue)
|
|
|
|
def iter_projects(self):
|
|
"""
|
|
Iter projects.
|
|
|
|
@return [iter(Project)] projects
|
|
"""
|
|
with self.browser:
|
|
for project in self.browser.iter_projects():
|
|
yield Project(project['id'], project['name'])
|
|
|
|
def get_project(self, id):
|
|
try:
|
|
with self.browser:
|
|
params = self.browser.get_issue(id)
|
|
except BrowserHTTPNotFound:
|
|
return None
|
|
|
|
return self._build_project(params['project'])
|
|
|
|
def fill_issue(self, issue, fields):
|
|
# currently there isn't cases where an Issue is uncompleted.
|
|
return issue
|
|
|
|
OBJECTS = {Issue: fill_issue}
|