102 lines
3.1 KiB
Python
102 lines
3.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright(C) 2011 Laurent Bachelier
|
|
#
|
|
# 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 .base import IBaseCap, CapBaseObject, NotLoaded
|
|
|
|
|
|
__all__ = ['PasteNotFound', 'BasePaste', 'ICapPaste']
|
|
|
|
|
|
class PasteNotFound(Exception):
|
|
pass
|
|
|
|
class BasePaste(CapBaseObject):
|
|
"""
|
|
Represents a pasted text.
|
|
"""
|
|
def __init__(self, _id, title=NotLoaded, language=NotLoaded, contents=NotLoaded,
|
|
public=NotLoaded):
|
|
CapBaseObject.__init__(self, unicode(_id))
|
|
|
|
self.add_field('title', basestring, title)
|
|
self.add_field('language', basestring, language)
|
|
self.add_field('contents', basestring, contents)
|
|
self.add_field('public', bool, public)
|
|
|
|
@classmethod
|
|
def id2url(cls, _id):
|
|
"""Overloaded in child classes provided by backends."""
|
|
raise NotImplementedError()
|
|
|
|
@property
|
|
def page_url(self):
|
|
return self.id2url(self.id)
|
|
|
|
|
|
class ICapPaste(IBaseCap):
|
|
"""
|
|
This capability represents the ability for a website backend to store plain text.
|
|
"""
|
|
|
|
def new_paste(self, *args, **kwargs):
|
|
"""
|
|
Get a new paste object for posting it with the backend.
|
|
The parameters should be passed to the object init.
|
|
|
|
@return a Paste object
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def can_post(self, contents, title=None, public=None, max_age=None):
|
|
"""
|
|
Checks if the paste can be pasted by this backend.
|
|
Some properties are considered required (public/private, max_age) while others
|
|
are just bonuses (language).
|
|
|
|
contents: Can be used to check encodability, maximum length, etc.
|
|
title: Can be used to check length, allowed characters. Should not be required.
|
|
public: True must be public, False must be private, None do not care.
|
|
max_age: Maximum time to live in seconds.
|
|
|
|
A score of 0 means the backend is not suitable.
|
|
A score of 1 means the backend is suitable.
|
|
Higher scores means it is more suitable than others with a lower score.
|
|
|
|
@return int Score
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def get_paste(self, url):
|
|
"""
|
|
Get a Paste from an ID or URL.
|
|
|
|
@param _id the paste id. It can be an ID or a page URL.
|
|
@return a Paste object
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def post_paste(self, paste, max_age=None):
|
|
"""
|
|
Post a paste.
|
|
|
|
@param paste Paste object
|
|
@return
|
|
"""
|
|
raise NotImplementedError()
|