'.format(
119 | name='file',
120 | accepted_types='data-accepted-types="image/gif,image/png"',
121 | lookups=json.dumps(settings.MIME_LOOKUPS)
122 | )
123 | )
124 |
125 | widget = S3FileUploadWidget(accepted_types=['image/gif', 'image/png'])
126 | actual = widget.render('file', None)
127 |
128 | assert actual == expected
129 |
--------------------------------------------------------------------------------
/buckets/fields.py:
--------------------------------------------------------------------------------
1 | import os
2 | from django.utils.translation import ugettext as _
3 | from django.core.files.storage import default_storage
4 | from django.db import models
5 |
6 | from .widgets import S3FileUploadWidget
7 |
8 |
9 | def key_from_url(url, upload_to):
10 | key = url.split('/')[-1]
11 |
12 | if upload_to:
13 | key = upload_to + '/' + key
14 | return key
15 |
16 |
17 | class S3File(object):
18 | """ This is the internal value an `S3FileField`. It provides access to the
19 | actual file on S3, e.g. for post-processing. It usually uses an
20 | instance of S3Storage to download, upload or delete the file on S3."""
21 | def __init__(self, url, field, original_url=None):
22 | self.field = field
23 | self.storage = field.storage
24 | self.url = url
25 | self.committed = True
26 | self.original_url = original_url if original_url is not None else url
27 |
28 | def _get_file(self):
29 | if not hasattr(self, '_file') or not self._file:
30 | name = self.url.split('/')[-1]
31 | if self.field.upload_to:
32 | name = self.field.upload_to + '/' + name
33 | path = self.storage.open(name)
34 | self._file = open(path, 'rb')
35 | return self._file
36 |
37 | def _set_file(self, file):
38 | self._file = file
39 | self.committed = False
40 |
41 | def _del_file(self):
42 | name = key_from_url(self.url, self.field.upload_to)
43 | self.storage.delete(name)
44 | if hasattr(self, '_file'):
45 | del self._file
46 |
47 | self.url = ''
48 |
49 | file = property(_get_file, _set_file, _del_file)
50 |
51 | def open(self):
52 | self._get_file()
53 | return self._file
54 |
55 | def save(self):
56 | if not self.committed:
57 | name = os.path.join(self.field.upload_to,
58 | os.path.basename(self._file.name))
59 | self.url = self.storage.save(name, self._file.read())
60 | self.committed = True
61 |
62 | return self.url
63 |
64 | def delete(self):
65 | self._del_file()
66 |
67 |
68 | class S3FileDescriptor(object):
69 | def __init__(self, field):
70 | self.field = field
71 |
72 | def __get__(self, instance, value):
73 | return instance.__dict__[self.field.name]
74 |
75 | def __set__(self, instance, value):
76 | if isinstance(value, S3File):
77 | instance.__dict__[self.field.name] = value
78 | else:
79 | o = None
80 | f = instance.__dict__.get(self.field.name)
81 | if f:
82 | o = f.url
83 | instance.__dict__[self.field.name] = S3File(value,
84 | self.field,
85 | original_url=o)
86 |
87 |
88 | class S3FileField(models.Field):
89 | """ Stores and provides access to a file stored in an AWS S3 bucket. To set
90 | the value of an `S3FileField` you usually provide the URL of the file
91 | in the bucket. Internally this URL is converted to a `S3File`, which
92 | provides access to the actual file on S3."""
93 | attr_class = S3File
94 | descriptor_class = S3FileDescriptor
95 |
96 | description = _("A file stored in an AWS S3 buckets.")
97 |
98 | def __init__(self, upload_to='', storage=None, accepted_types=None,
99 | *args, **kwargs):
100 | self.storage = storage or default_storage
101 | self.upload_to = upload_to
102 | self.accepted_types = accepted_types
103 |
104 | kwargs['max_length'] = kwargs.get('max_length', 200)
105 | super(S3FileField, self).__init__(*args, **kwargs)
106 |
107 | def get_internal_type(self):
108 | return 'CharField'
109 |
110 | def contribute_to_class(self, cls, name, **kwargs):
111 | super(S3FileField, self).contribute_to_class(cls, name, **kwargs)
112 | setattr(cls, self.name, self.descriptor_class(self))
113 |
114 | def deconstruct(self):
115 | name, path, args, kwargs = super(S3FileField, self).deconstruct()
116 |
117 | if self.upload_to != '':
118 | kwargs['upload_to'] = self.upload_to
119 |
120 | if self.storage != default_storage:
121 | kwargs['storage'] = self.storage
122 |
123 | if kwargs.get('max_length') == 200:
124 | del kwargs['max_length']
125 |
126 | return name, path, args, kwargs
127 |
128 | def from_db_value(self, value, expression, connection, context):
129 | return S3File(value, self, original_url=value)
130 |
131 | def to_python(self, value):
132 | if value is None or isinstance(value, S3File):
133 | return value
134 | return S3File(value, self)
135 |
136 | def get_prep_value(self, value):
137 | if isinstance(value, S3File):
138 | return value.url
139 |
140 | return value
141 |
142 | def pre_save(self, model_instance, add):
143 | file = getattr(model_instance, self.name)
144 | file.save()
145 | if not add and file.original_url and file.original_url != file.url:
146 | key = key_from_url(file.original_url, self.upload_to)
147 | self.storage.delete(key)
148 |
149 | return file.url
150 |
151 | def formfield(self, *args, **kwargs):
152 | widget = S3FileUploadWidget(upload_to=self.upload_to,
153 | accepted_types=self.accepted_types)
154 | defaults = {'widget': widget}
155 | defaults.update(kwargs)
156 | return super(S3FileField, self).formfield(**defaults)
157 |
--------------------------------------------------------------------------------
/tests/test_test.py:
--------------------------------------------------------------------------------
1 | import os
2 | from django.conf import settings
3 | try:
4 | # For Django 1.11
5 | from django.core.urlresolvers import reverse, resolve
6 | except ImportError:
7 | # For Django 2.0
8 | from django.urls import reverse, resolve
9 | from django.http import HttpRequest
10 | from django.core.files.uploadedfile import SimpleUploadedFile
11 |
12 | from buckets.test.mocks import create_file, make_dirs # noqa
13 | from buckets.test.storage import FakeS3Storage
14 | from buckets.test import views, errors
15 |
16 |
17 | #############################################################################
18 |
19 | # FakeS3Storage
20 |
21 | #############################################################################
22 |
23 |
24 | def test_open(make_dirs): # noqa
25 | file = create_file()
26 | with open(os.path.join(settings.MEDIA_ROOT,
27 | 's3', 'uploads', 'text.txt'), 'wb') as dest_file:
28 | dest_file.write(open(file.name, 'rb').read())
29 |
30 | store = FakeS3Storage()
31 | downloaded = store.open('text.txt')
32 | assert open(downloaded, 'rb').read().decode() == 'Some content'
33 | assert os.path.isfile(
34 | os.path.join(settings.MEDIA_ROOT, 's3', 'uploads', 'text.txt'))
35 |
36 |
37 | def test_save(make_dirs): # noqa
38 | file = create_file()
39 | store = FakeS3Storage()
40 | url = store.save('text.txt', open(file.name, 'rb').read())
41 |
42 | assert url == '/media/s3/uploads/text.txt'
43 | assert os.path.isfile(
44 | os.path.join(settings.MEDIA_ROOT, 's3', 'uploads', 'text.txt'))
45 |
46 |
47 | def test_save_with_subdir(make_dirs): # noqa
48 | file = create_file()
49 | store = FakeS3Storage()
50 | url = store.save('somedir/text.txt', open(file.name, 'rb').read())
51 |
52 | assert url == '/media/s3/uploads/somedir/text.txt'
53 | assert os.path.isfile(
54 | os.path.join(settings.MEDIA_ROOT, 's3/uploads/somedir/text.txt'))
55 |
56 |
57 | def test_delete(make_dirs): # noqa
58 | file = create_file()
59 | with open(os.path.join(settings.MEDIA_ROOT,
60 | 's3', 'uploads', 'delete.txt'), 'wb') as dest_file:
61 | dest_file.write(open(file.name, 'rb').read())
62 |
63 | store = FakeS3Storage()
64 | store.delete('delete.txt')
65 | assert not os.path.isfile(
66 | os.path.join(settings.MEDIA_ROOT, 's3,' 'uploads', 'text.txt'))
67 |
68 |
69 | def test_delete_non_exising_file(make_dirs): # noqa
70 | store = FakeS3Storage()
71 | store.delete('/media/s3/uploads/delete.txt')
72 |
73 |
74 | def test_get_signed_url():
75 | store = FakeS3Storage()
76 |
77 | signed = store.get_signed_url(key='file.txt')
78 | assert '/media/s3/uploads/' == signed['url']
79 | assert len(signed['fields']['key']) == 28
80 |
81 |
82 | def test_content_via_save(make_dirs): # noqa
83 | store = FakeS3Storage()
84 | txt = 'blah'
85 | content = str.encode(txt)
86 | url = store.save('blah.txt', content)
87 | assert url == '/media/s3/uploads/blah.txt'
88 |
89 |
90 | #############################################################################
91 |
92 | # URLs
93 |
94 | #############################################################################
95 |
96 |
97 | def test_urls():
98 | assert reverse('fake_s3_upload') == '/media/s3/uploads/'
99 |
100 | resolved = resolve('/media/s3/uploads/')
101 | assert resolved.func.__name__ == views.fake_s3_upload.__name__
102 |
103 |
104 | #############################################################################
105 |
106 | # fake_s3_upload
107 |
108 | #############################################################################
109 |
110 | def test_get_upload_file():
111 | request = HttpRequest()
112 | setattr(request, 'method', 'GET')
113 |
114 | response = views.fake_s3_upload(request)
115 | assert response.status_code == 405
116 |
117 |
118 | def test_post_upload_file(make_dirs, monkeypatch): # noqa
119 | monkeypatch.setattr(views, 'default_storage', FakeS3Storage())
120 | file = create_file()
121 | request = HttpRequest()
122 | setattr(request, 'method', 'POST')
123 | setattr(request, 'FILES', {
124 | 'file': SimpleUploadedFile('text.txt', open(file.name, 'rb').read())
125 | })
126 | setattr(request, 'POST', {
127 | 'key': 'text.txt'
128 | })
129 | response = views.fake_s3_upload(request)
130 | assert response.status_code == 204
131 | assert os.path.isfile(
132 | os.path.join(settings.MEDIA_ROOT, 's3', 'uploads', 'text.txt'))
133 |
134 |
135 | def test_post_upload_file_to_subdir(make_dirs, monkeypatch): # noqa
136 | monkeypatch.setattr(views, 'default_storage', FakeS3Storage())
137 | file = create_file()
138 | request = HttpRequest()
139 | setattr(request, 'method', 'POST')
140 | setattr(request, 'FILES', {
141 | 'file': SimpleUploadedFile('text.txt', open(file.name, 'rb').read())
142 | })
143 | setattr(request, 'POST', {
144 | 'key': 'subdir/text.txt'
145 | })
146 | response = views.fake_s3_upload(request)
147 | assert response.status_code == 204
148 | assert os.path.isfile(
149 | os.path.join(settings.MEDIA_ROOT, 's3/uploads/subdir', 'text.txt'))
150 |
151 |
152 | def test_post_large_file(make_dirs, monkeypatch, settings): # noqa
153 | monkeypatch.setattr(views, 'default_storage', FakeS3Storage())
154 | file = create_file()
155 |
156 | upload = SimpleUploadedFile('text.txt', open(file.name, 'rb').read())
157 | upload.size = settings.AWS['MAX_FILE_SIZE'] + 1
158 |
159 | request = HttpRequest()
160 | setattr(request, 'method', 'POST')
161 | setattr(request, 'FILES', {'file': upload})
162 | setattr(request, 'POST', {'key': 'subdir/text.txt'})
163 | response = views.fake_s3_upload(request)
164 | assert response.status_code == 400
165 | assert response.content.decode('utf-8') == errors.EXCEED_MAX_SIZE.format(
166 | max_size=settings.AWS['MAX_FILE_SIZE'],
167 | proposed_size=settings.AWS['MAX_FILE_SIZE'] + 1)
168 | assert not os.path.isfile(
169 | os.path.join(settings.MEDIA_ROOT, 's3/uploads/subdir', 'text.txt'))
170 |
--------------------------------------------------------------------------------
/buckets/static/buckets/js/script.js:
--------------------------------------------------------------------------------
1 | (function () {
2 | var link_update = document.createEvent('Event');
3 | link_update.initEvent('link:update', true, true);
4 |
5 | function toMB(bytes) {
6 | // Convert bytes to MB and round to two decimals.
7 | return Math.round(bytes / (1024*1024) * 100) / 100;
8 | }
9 |
10 | function getParentByTagName(el, tagName) {
11 | var p = el.parentElement;
12 |
13 | if (p.tagName === tagName.toUpperCase()) {
14 | return p;
15 | } else {
16 | return getParentByTagName(p, tagName);
17 | }
18 | }
19 |
20 | var uploads = 0;
21 | function disableSubmit(el, status) {
22 | if (status) uploads++;
23 | else uploads--;
24 |
25 | var form = getParentByTagName(el, 'form');
26 | var submitBtn = form.querySelector('[type="submit"]');
27 |
28 | submitBtn.disabled = (uploads > 0);
29 | }
30 |
31 | function message(el, msg) {
32 | if (msgP = el.querySelector('.message')) { msgP.remove(); }
33 | if (msg) {
34 | var msgP = document.createElement('p');
35 | msgP.setAttribute('class', 'help-block message');
36 | msgP.appendChild(document.createTextNode(msg));
37 | el.insertBefore(msgP, el.firstChild);
38 | }
39 | }
40 |
41 | function clearErrors(el) {
42 | if (errs = el.querySelector('.errors')) { errs.remove(); }
43 | }
44 |
45 | function error(el, msg) {
46 | message(el);
47 | el.querySelector('.file-url').value = '';
48 | el.querySelector('.file-input').value = '';
49 |
50 | clearErrors(el);
51 |
52 | var errorList = document.createElement('ul');
53 | errorList.setAttribute('class', 'errors');
54 | var errorMessage = document.createElement('li');
55 | errorMessage.appendChild(document.createTextNode(msg))
56 | errorList.appendChild(errorMessage);
57 |
58 | el.insertBefore(errorList, el.firstChild);
59 | disableSubmit(el, false);
60 | }
61 |
62 | function update(el, fileUrl) {
63 | var link = el.querySelector('.file-link'),
64 | url = el.querySelector('.file-url');
65 |
66 | clearErrors(el);
67 |
68 | url.value = fileUrl;
69 | link.href = fileUrl;
70 | link.innerHTML = fileUrl.split('/').pop();
71 | link.dispatchEvent(link_update);
72 |
73 | el.classList.add('uploaded');
74 | disableSubmit(el, false);
75 | message(el);
76 | }
77 |
78 | function getCookie(name) {
79 | var value = '; ' + document.cookie,
80 | parts = value.split('; ' + name + '=')
81 | if (parts.length == 2) return parts.pop().split(';').shift()
82 | }
83 |
84 | function request(method, url, data, headers, el, callback) {
85 | var req = new XMLHttpRequest();
86 | req.open(method, url, true);
87 |
88 | Object.keys(headers).forEach(function(key){
89 | req.setRequestHeader(key, headers[key])
90 | });
91 |
92 | req.onload = function() {
93 | callback(req.status, req.responseText);
94 | }
95 |
96 | req.onerror = req.onabort = function() {
97 | disableSubmit(el, false)
98 | error(el, 'Not able to upload file');
99 | }
100 |
101 | req.send(data)
102 | }
103 |
104 | function uploadFile(e, data) {
105 | var el = e.target.parentElement,
106 | file = el.querySelector('.file-input').files[0],
107 | formData = new FormData(),
108 | headers = {'X-CSRFToken': getCookie('csrftoken')};
109 |
110 | var url = data.url;
111 | Object.keys(data.fields).forEach(function(key){
112 | formData.append(key, data.fields[key])
113 | })
114 | formData.append('file', file);
115 |
116 | request('POST', url, formData, headers, el, function(status, response) {
117 | if (status !== 204) {
118 | var errorMsg = 'Not able to upload file. ';
119 |
120 | var xml = new DOMParser().parseFromString(response, "text/xml");
121 | if (xml.getElementsByTagName('Code')[0].innerHTML === 'EntityTooLarge') {
122 | var limit = parseInt(xml.getElementsByTagName('MaxSizeAllowed')[0].innerHTML);
123 |
124 | errorMsg += 'The size of the file exceeds the maximum allowed size of ' + toMB(limit) + 'MB.';
125 | }
126 |
127 | error(el, errorMsg)
128 | } else {
129 | var fileUrl = data.url + data.fields.key;
130 | update(el, fileUrl);
131 | }
132 | });
133 | }
134 |
135 | function getSignedUrl(e) {
136 | var el = e.target.parentElement,
137 | file = el.querySelector('.file-input').files[0],
138 | form = new FormData(),
139 | headers = {'X-CSRFToken': getCookie('csrftoken')},
140 | url = '/s3/signed-url/';
141 |
142 | var key = file.name;
143 | if (el.getAttribute('data-upload-to')) {
144 | key = el.getAttribute('data-upload-to') + '/' + key;
145 | }
146 |
147 | form.append('key', key);
148 |
149 | request('POST', url, form, headers, el, function(status, response) {
150 | if (status !== 200) {
151 | error(el, 'Not able to upload file')
152 | } else {
153 | uploadFile(e, JSON.parse(response));
154 | }
155 | });
156 | }
157 |
158 | function checkType(e) {
159 | var el = e.target.parentElement,
160 | file = el.querySelector('.file-input').files[0],
161 | accepted = el.getAttribute('data-accepted-types');
162 |
163 | clearErrors(el);
164 |
165 | disableSubmit(el, true);
166 | var ext = file.name.split('.').slice(-1)[0];
167 | var type = file.type || MIME_LOOKUPS[ext];
168 |
169 | if (!accepted || accepted.split(',').indexOf(type) !== -1) {
170 | getSignedUrl(e);
171 | message(el, 'Uploading...');
172 | } else {
173 | error(el, 'File type not allowed.');
174 | disableSubmit(el, false);
175 | }
176 | }
177 |
178 | function removeFile(e) {
179 | e.preventDefault();
180 |
181 | var el = e.target.parentElement.parentElement;
182 | el.querySelector('.file-url').value = '';
183 | el.querySelector('.file-input').value = '';
184 | el.classList.remove('uploaded');
185 | }
186 |
187 | function addEventHandlers(el) {
188 | var input = el.querySelector('.file-input'),
189 | remove = el.querySelector('.file-remove');
190 |
191 | input.addEventListener('change', checkType, false);
192 | remove.addEventListener('click', removeFile, false);
193 | }
194 |
195 | document.addEventListener('DOMContentLoaded', function(e) {
196 | ;[].forEach.call(document.querySelectorAll('.s3-buckets'), addEventHandlers)
197 | })
198 |
199 | document.addEventListener('DOMNodeInserted', function(e){
200 | if(e.target.tagName) {
201 | var el = e.target.querySelector('.s3-buckets')
202 | if(el) addEventHandlers(el)
203 | }
204 | })
205 | }());
206 |
--------------------------------------------------------------------------------
/tests/test_fields.py:
--------------------------------------------------------------------------------
1 | import os
2 | import pytest
3 |
4 | from django.conf import settings
5 | from django.core.files.uploadedfile import SimpleUploadedFile
6 |
7 | from buckets.fields import S3File, S3FileField, key_from_url
8 | from buckets.widgets import S3FileUploadWidget
9 | from buckets.test.mocks import create_file, make_dirs # noqa
10 | from buckets.test.storage import FakeS3Storage
11 | from .models import FileModel
12 |
13 |
14 | #############################################################################
15 |
16 | # S3File
17 |
18 | #############################################################################
19 |
20 | def test_init():
21 | field = S3FileField(storage=FakeS3Storage())
22 | file = S3File('https://example.com/text.txt', field)
23 |
24 | assert file.url == 'https://example.com/text.txt'
25 | assert file.field is field
26 | assert isinstance(file.storage, FakeS3Storage)
27 |
28 |
29 | def test_get_file(make_dirs): # noqa
30 | file = create_file()
31 | with open(os.path.join(settings.MEDIA_ROOT,
32 | 's3/uploads/files/text.txt'), 'wb') as dest_file:
33 | dest_file.write(open(file.name, 'rb').read())
34 |
35 | field = S3FileField(upload_to='files', storage=FakeS3Storage())
36 |
37 | s3_file = S3File('/media/s3/uploads/files/text.txt', field)
38 | downloaded = s3_file.open()
39 |
40 | assert downloaded.read().decode() == 'Some content'
41 | assert os.path.isfile(
42 | os.path.join(settings.MEDIA_ROOT, 's3/uploads/files/text.txt'))
43 |
44 |
45 | def test_set_file_and_save(make_dirs): # noqa
46 | field = S3FileField(storage=FakeS3Storage())
47 | s3_file = S3File('/media/s3/uploads/text.txt', field)
48 | s3_file.file = SimpleUploadedFile(
49 | 'text.txt', open(create_file().name, 'rb').read())
50 | assert s3_file.committed is False
51 | url = s3_file.save()
52 |
53 | assert url == '/media/s3/uploads/text.txt'
54 | assert s3_file.committed is True
55 | assert os.path.isfile(
56 | os.path.join(settings.MEDIA_ROOT, 's3', 'uploads', 'text.txt'))
57 |
58 |
59 | def test_delete_file(make_dirs): # noqa
60 | file = create_file()
61 | with open(os.path.join(settings.MEDIA_ROOT,
62 | 's3', 'uploads', 'text.txt'), 'wb') as dest_file:
63 | dest_file.write(open(file.name, 'rb').read())
64 |
65 | field = S3FileField(storage=FakeS3Storage())
66 |
67 | s3_file = S3File('/media/s3/uploads/text.txt', field)
68 | s3_file.file = dest_file
69 | s3_file.delete()
70 |
71 | assert not hasattr(s3_file, '_file')
72 | assert not os.path.isfile(
73 | os.path.join(settings.MEDIA_ROOT, 's3', 'uploads', 'text.txt'))
74 |
75 |
76 | # #############################################################################
77 | #
78 | # S3FileField
79 | #
80 | # #############################################################################
81 |
82 | def test_deconstruct_default_kwargs():
83 | field = S3FileField()
84 | name, path, args, kwargs = field.deconstruct()
85 |
86 | assert name is None
87 | assert path == 'buckets.fields.S3FileField'
88 | assert args == []
89 |
90 | assert 'max_length' not in kwargs
91 | assert 'upload_to' not in kwargs
92 | assert 'storage' not in kwargs
93 |
94 |
95 | def test_deconstruct_custom_kwargs():
96 | field = S3FileField(upload_to='/uploads/',
97 | storage=FakeS3Storage(),
98 | max_length=400)
99 | name, path, args, kwargs = field.deconstruct()
100 |
101 | assert name is None
102 | assert path == 'buckets.fields.S3FileField'
103 | assert args == []
104 |
105 | assert kwargs['max_length'] == 400
106 | assert kwargs['upload_to'] == '/uploads/'
107 | assert isinstance(kwargs['storage'], FakeS3Storage)
108 |
109 |
110 | def test_from_db_value():
111 | field = S3FileField()
112 | converted = field.from_db_value('https://example.com/test.text',
113 | None, None, None)
114 | assert isinstance(converted, S3File)
115 | assert converted.url == 'https://example.com/test.text'
116 |
117 |
118 | def test_to_python_with_None():
119 | field = S3FileField()
120 | python_obj = field.to_python(None)
121 | assert python_obj is None
122 |
123 |
124 | def test_to_python_with_S3File():
125 | field = S3FileField()
126 | file = S3File('https://example.com/test.text', field)
127 | python_obj = field.to_python(file)
128 | assert python_obj is file
129 |
130 |
131 | def test_to_python_with_url():
132 | field = S3FileField()
133 | python_obj = field.to_python('https://example.com/test.text')
134 | assert isinstance(python_obj, S3File)
135 | assert python_obj.url == 'https://example.com/test.text'
136 |
137 |
138 | def test_get_prep_value():
139 | field = S3FileField()
140 | s3_file = S3File('https://example.com/test.text', field)
141 |
142 | url = field.get_prep_value(s3_file)
143 | assert url == 'https://example.com/test.text'
144 |
145 |
146 | def test_get_internal_type():
147 | field = S3FileField()
148 | assert field.get_internal_type() == 'CharField'
149 |
150 |
151 | def test_formfield():
152 | field = S3FileField()
153 | form_field = field.formfield()
154 | assert isinstance(form_field.widget, S3FileUploadWidget)
155 |
156 |
157 | def test_formfield_with_kwargs():
158 | field = S3FileField(upload_to='test', accepted_types=['image/png'])
159 | form_field = field.formfield()
160 | assert isinstance(form_field.widget, S3FileUploadWidget)
161 | assert form_field.widget.upload_to == 'test'
162 | assert form_field.widget.accepted_types == ['image/png']
163 |
164 |
165 | @pytest.mark.django_db
166 | def test_save_with_url():
167 | m = FileModel.objects.create(s3_file='http://example.com')
168 | assert isinstance(m.s3_file, S3File)
169 | assert m.s3_file.url == 'http://example.com'
170 |
171 |
172 | @pytest.mark.django_db
173 | def test_save_with_file():
174 | file = S3File('/someurl/text.txt', S3FileField())
175 | m = FileModel.objects.create(s3_file=file)
176 | assert m.s3_file is file
177 |
178 |
179 | def test_pre_save():
180 | model_instance = FileModel(
181 | s3_file='http://example.com'
182 | )
183 | field = S3FileField(name='s3_file')
184 | field._original_url = 'http://example.com'
185 | url = field.pre_save(model_instance, False)
186 |
187 | assert url == 'http://example.com'
188 |
189 |
190 | @pytest.mark.django_db
191 | def test_pre_save_replace_file():
192 | file = create_file()
193 | with open(os.path.join(settings.MEDIA_ROOT,
194 | 's3/uploads/text.txt'), 'wb') as dest_file:
195 | dest_file.write(open(file.name, 'rb').read())
196 | with open(os.path.join(settings.MEDIA_ROOT,
197 | 's3/uploads/text2.txt'), 'wb') as dest_file:
198 | dest_file.write(open(file.name, 'rb').read())
199 |
200 | model_instance = FileModel(s3_file='/media/s3/uploads/text.txt')
201 | model_instance.save()
202 | model_instance.refresh_from_db()
203 |
204 | field = model_instance.s3_file.field
205 | field.storage = FakeS3Storage()
206 | model_instance.s3_file = '/media/s3/uploads/text2.txt'
207 | url = field.pre_save(model_instance, False)
208 | assert url == '/media/s3/uploads/text2.txt'
209 | assert not os.path.isfile(os.path.join(settings.MEDIA_ROOT,
210 | 's3/uploads/text.txt'))
211 |
212 |
213 | @pytest.mark.django_db
214 | def test_pre_save_delete_file():
215 | file = create_file()
216 | with open(os.path.join(settings.MEDIA_ROOT,
217 | 's3/uploads/text.txt'), 'wb') as dest_file:
218 | dest_file.write(open(file.name, 'rb').read())
219 |
220 | model_instance = FileModel(s3_file='/media/s3/uploads/text.txt')
221 | model_instance.save()
222 | model_instance.refresh_from_db()
223 |
224 | field = model_instance.s3_file.field
225 | field.storage = FakeS3Storage()
226 | model_instance.s3_file = ''
227 | url = field.pre_save(model_instance, False)
228 | assert url == ''
229 | assert not os.path.isfile(os.path.join(settings.MEDIA_ROOT,
230 | 's3/uploads/text.txt'))
231 |
232 |
233 | def test_key_from_url():
234 | assert (key_from_url('http://example.com/some/dir/file.txt', None) ==
235 | 'file.txt')
236 | assert (key_from_url('http://example.com/some/dir/file.txt', 'some/dir') ==
237 | 'some/dir/file.txt')
238 |
--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
1 | django-buckets
2 | ===============================================================================
3 |
4 | |pypi-version| |build-status-image|
5 |
6 | django-buckets provides a Django storage system (:code:`S3Storage`) to store files on
7 | `Amazon S3 `_. Besides the storage itself, the
8 | library comes with a custom model field (:code:`S3FileField`) to reference
9 | files in Django and a form widget that handles uploading files to S3 using
10 | `pre-signed URLs `_.
11 |
12 | For testing and development, django-buckets offers :code:`S3FakeStorage` and
13 | the API endpoint :code:`/media/s3/uploads`, which mimics the behavior of
14 | :code:`S3Storage` and AWS S3's file upload API but use the local file system.
15 | Both integrate seamlessly with :code:`S3FileField`.
16 |
17 | **django-buckets is work in progress and not stable. Things might break.**
18 |
19 | Requirements
20 | -------------------------------------------------------------------------------
21 | - Python 3.4 or 3.5
22 | - Django 1.11 or 2.0
23 |
24 | Setup
25 | -------------------------------------------------------------------------------
26 |
27 | Installation
28 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29 |
30 | .. code-block::
31 |
32 | pip install django-buckets
33 |
34 | For production
35 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 |
37 | In settings, add :code:`buckets` to installed apps and set :code:`S3Storage`
38 | as default storage. Configure the :code:`AWS` settings by providing the S3
39 | bucket name AWS access key and secret key and the AWS region where your
40 | bucket is located.
41 |
42 | .. code-block:: python
43 |
44 | INSTALLED_APPS = (
45 | ...
46 | 'buckets',
47 | )
48 |
49 | DEFAULT_FILE_STORAGE = 'buckets.storage.S3Storage'
50 |
51 | AWS = {
52 | 'BUCKET': 'some-bucket',
53 | 'ACCESS_KEY': 'J36RZO0MO9JQ6NWAOY2I',
54 | 'SECRET_KEY': 'EaANd90ZdgiykkXEf67fNRnhc96zcGnkgDhagj6v',
55 | 'REGION': 'us-east-1'
56 | }
57 |
58 | Include django-buckets' URLs to add an `API endpoint <#api>`_, which is
59 | used by the form widget or REST-clients to request valid signed URLs.
60 |
61 | .. code-block:: python
62 |
63 | urlpatterns = [
64 | url(r'', include('buckets.urls')),
65 | ]
66 |
67 | Edit the CORS policy of the S3 bucket you intend to use to allow for POST
68 | requests:
69 |
70 | .. code-block:: xml
71 |
72 |
73 |
74 | *
75 | POST
76 | GET
77 | 3000
78 | *
79 |
80 |
81 |
82 | For testing and development
83 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
84 |
85 | In settings, add :code:`buckets` to installed apps and set
86 | :code:`FakeS3Storage` as default default storage.
87 |
88 | .. code-block:: python
89 |
90 | DEFAULT_FILE_STORAGE = 'buckets.test.storage.FakeS3Storage'
91 |
92 | Include django-buckets' URLs to add an `API endpoint <#api>`_, which is
93 | used by the form widget or REST-clients to request valid signed URLs. Further,
94 | it will add a file upload endpoint, which behaves like S3's file upload but
95 | stores files on the local file system, so you don't need to configure an S3
96 | bucket for development.
97 |
98 | .. code-block:: python
99 |
100 | INSTALLED_APPS = (
101 | ...
102 | 'buckets',
103 | )
104 |
105 | urlpatterns = [
106 | url(r'', include('buckets.test.urls')),
107 | ]
108 |
109 | Other settings
110 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
111 |
112 | Other optional settings can be added to the :code:`AWS` settings dictionary.
113 |
114 | ===================== =========== ========================================================================
115 | Name Type Description
116 | ===================== =========== ========================================================================
117 | :code:`MAX_FILE_SIZE` :code:`int` The maximum allowed size for file uploads in bytes. If :code:`MAX_FILE_SIZE` is not defined then there will be no limit to the size of file.
118 | ===================== =========== ========================================================================
119 |
120 | Usage
121 | -------------------------------------------------------------------------------
122 |
123 | Create a model with an :code:`S3FileField`
124 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125 |
126 | Create a model class, which has an :code:`S3FileField`. Internally, S3FileField
127 | is a Django `CharField `_
128 | and it accepts the same arguments.
129 |
130 | :code:`S3FileField` accepts two additional optional arguments:
131 |
132 | - :code:`upload_to` defines an upload directory, where uploaded files should are (similar to `FileField `_)
133 | - :code:`accepted_types` defines a list mime types that are accepted to upload. If you do not provide this argument, all types will be accepted.
134 |
135 | .. code-block:: python
136 |
137 | from django.db import models
138 | from buckets.fields import S3FileField
139 |
140 | class MyModel(models.Model):
141 | name = models.CharField(max_length=200)
142 | file = S3FileField(upload_to='some-dir',
143 | accepted_types=['image/png', 'image/jpeg'])
144 |
145 |
146 | Instanciate the model
147 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
148 |
149 | An :code:`S3FileField` accepts an URL as its value:
150 |
151 | .. code-block:: python
152 |
153 | file_model = MyModel.objects.create(
154 | name='My File',
155 | file='https://s3.amazonaws.com/some-bucket/file.txt'
156 | )
157 |
158 | Reading and writing the file
159 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
160 |
161 | Internally, an instance of :code:`S3File` is created from the URL that provides
162 | access to the file itself.
163 |
164 | .. code-block:: python
165 |
166 | # downloads the file and returns a File object
167 | file = file_model.file.open()
168 |
169 | # assign an updated file
170 | file_model.file = file
171 |
172 | Usage with Django forms
173 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
174 |
175 | django-buckets comes with a form widget that takes care of uploading files,
176 | displaying links to files and filling the form fields. It's the easiest way to
177 | use django-buckets in your application.
178 |
179 | To use the widget, make sure the widget's media files (some JS and CSS) are
180 | added to the template, ideally somewhere in the page's :code:`head`:
181 |
182 | .. code-block:: html
183 |
184 |
185 |
186 |
187 | django-buckets File Upload
188 | {{ form.media }}
189 |
190 | ...
191 |
192 |
193 | You can use Django's standard form rendering methods and the necessary HTML
194 | elements are added to the page:
195 |
196 | .. code-block:: html
197 |
198 |
199 | ...
200 |
201 | {{ form.as_p }}
202 |
203 |
204 |
205 |
206 | Use a custom widget
207 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
208 |
209 | If you plan to use a custom widget in your forms, you can add a Django
210 | :code:`CharField` to your form and provide the widget you want to use:
211 |
212 | .. code-block:: python
213 |
214 | from django import forms
215 | from .models import MyModel
216 |
217 | class MyModelForm(forms.ModelForm):
218 | file = forms.CharField(widget=MyWidget)
219 |
220 | class Meta:
221 | model = MyModel
222 | fields = ['name', 'file']
223 |
224 |
225 |
226 | API
227 | -------------------------------------------------------------------------------
228 |
229 | Getting a signed URL
230 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
231 |
232 | If you are building an API-only application, you can get a signed URL by
233 | POSTing :code:`client_method` and :code:`http_method`.
234 |
235 | Request
236 | `````````````
237 |
238 | .. code-block::
239 |
240 | POST /s3/signed-url/
241 | Accept: application/json
242 | Content-Type: application/json
243 |
244 | {
245 | "key": "file.txt"
246 | }
247 |
248 | Response
249 | `````````````
250 |
251 | .. code-block::
252 |
253 | HTTP/1.1 200 OK
254 | Content-Type: application/json
255 |
256 | {
257 | "url": "https://s3.amazonaws.com/some-bucket",
258 | "fields": {
259 | "key": "file.txt",
260 | "x-amz-credential": "HKJXXOZ7L71OMC9S830I/20160425/us-east-1/s3/aws4_request",
261 | "policy": "AORKx5gcfIIMJQUyKAkdCUDapV99I8PAn592rjN2of6Hodk1HNiFrj1ItWdJpuQiwrYVi0NJMnfCxfmfVlZg9NDpKFQi8b5vSpWpamMu5UVUdg9c8A77lF1fuWOty8Xx4qUza8EXxuz49mYYRhRym8TRNzx4v9qDwPmILe6FRl7BGSlIijn46Td9OroAHJoUPp2YU1dwsGOXGZufCGHJ8C3m1vM0YmPhDTvt2WABGscgqJmKB57SkKmnixCWYhoy",
262 | "x-amz-date": "20160425T180721Z",
263 | "x-amz-algorithm": "AWS4-HMAC-SHA256",
264 | "x-amz-signature": "bOSxtzlFNaoAfa6rzjimXBN1KIE1uQ8k1h1sCn0U7lvwYK8whuflP5PcFU8KgzxQ"
265 | }
266 | }
267 |
268 | To upload the file to AWS S3, send the file via POST to the URL given in the
269 | response and include all :code:`fields` with the request payload.
270 |
271 | .. code-block::
272 |
273 | POST https://s3.amazonaws.com/some-bucket
274 | Content-Type:multipart/form-data; boundary=----WebKitFormBoundary7LwCXdHGMv2KBDza
275 |
276 | ------WebKitFormBoundary7LwCXdHGMv2KBDza
277 | Content-Disposition: form-data; name="key"
278 |
279 | file.txt
280 | ------WebKitFormBoundary7LwCXdHGMv2KBDza
281 | Content-Disposition: form-data; name="x-amz-algorithm"
282 |
283 | AWS4-HMAC-SHA256
284 | ------WebKitFormBoundary7LwCXdHGMv2KBDza
285 | Content-Disposition: form-data; name="x-amz-date"
286 |
287 | 20160425T180721Z
288 | ------WebKitFormBoundary7LwCXdHGMv2KBDza
289 | Content-Disposition: form-data; name="x-amz-signature"
290 |
291 | bOSxtzlFNaoAfa6rzjimXBN1KIE1uQ8k1h1sCn0U7lvwYK8whuflP5PcFU8KgzxQ
292 | ------WebKitFormBoundary7LwCXdHGMv2KBDza
293 | Content-Disposition: form-data; name="policy"
294 |
295 | AORKx5gcfIIMJQUyKAkdCUDapV99I8PAn592rjN2of6Hodk1HNiFrj1ItWdJpuQiwrYVi0NJMnfCxfmfVlZg9NDpKFQi8b5vSpWpamMu5UVUdg9c8A77lF1fuWOty8Xx4qUza8EXxuz49mYYRhRym8TRNzx4v9qDwPmILe6FRl7BGSlIijn46Td9OroAHJoUPp2YU1dwsGOXGZufCGHJ8C3m1vM0YmPhDTvt2WABGscgqJmKB57SkKmnixCWYhoy
296 | ------WebKitFormBoundary7LwCXdHGMv2KBDza
297 | Content-Disposition: form-data; name="x-amz-credential"
298 |
299 | HKJXXOZ7L71OMC9S830I/20160425/us-east-1/s3/aws4_request
300 | ------WebKitFormBoundary7LwCXdHGMv2KBDza
301 | Content-Disposition: form-data; name="file"
302 |
303 | Content-Disposition: form-data; name="file"; filename="file.txt"
304 | Content-Type: application/octet-stream
305 |
306 | ------WebKitFormBoundary7LwCXdHGMv2KBDza
307 |
308 |
309 | .. |build-status-image| image:: https://travis-ci.org/Cadasta/django-buckets.svg?branch=master
310 | :target: https://travis-ci.org/Cadasta/django-buckets
311 | .. |pypi-version| image:: https://img.shields.io/pypi/v/django-buckets.svg
312 | :target: https://pypi.python.org/pypi/django-buckets
313 |
314 |
315 | Deleting a file
316 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
317 |
318 | Request
319 | `````````````
320 |
321 | .. code-block::
322 |
323 | POST /s3/delete-resource/
324 | Accept: application/json
325 | Content-Type: application/json
326 |
327 | {
328 | "key": "file.txt"
329 | }
330 |
331 |
332 | Response
333 | `````````````
334 |
335 | *When the file was deleted successfully:*
336 |
337 | .. code-block::
338 |
339 | HTTP/1.1 204 No Content
340 |
341 | *When the file was not found:*
342 |
343 | .. code-block::
344 |
345 | HTTP/1.1 400 Bad Request
346 | Content-Type: application/json
347 |
348 | {
349 | "error": "S3 resource does not exist."
350 | }
351 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published
637 | by the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------