├── .gitignore ├── AUTHORS ├── CHANGES.rst ├── LICENSE ├── MANIFEST.in ├── README.rst ├── any_imagefield ├── __init__.py ├── forms │ ├── __init__.py │ ├── fields.py │ └── widgets.py ├── models │ ├── __init__.py │ ├── backends │ │ ├── __init__.py │ │ ├── default.py │ │ ├── filebrowser.py │ │ ├── filer.py │ │ ├── preview.py │ │ └── sorl.py │ └── fields.py └── templates │ └── any_imagefield │ └── imagepreviewwidget │ └── update.html └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.pyo 3 | *.mo 4 | *.db 5 | *.egg-info/ 6 | .project 7 | .idea/ 8 | .pydevproject 9 | .idea/workspace.xml 10 | .DS_Store 11 | build/ 12 | dist/ 13 | docs/_build/ 14 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Diederik van der Boor 2 | 3 | Patches by: 4 | * Basil S. 5 | * François Guérin 6 | -------------------------------------------------------------------------------- /CHANGES.rst: -------------------------------------------------------------------------------- 1 | Changes in 1.1 (2020-03-02) 2 | --------------------------- 3 | 4 | * Fixed ``solr.FixedSorlAdminImageWidget.render()`` method for Django 2.1+ 5 | 6 | 7 | Changes in 1.0 (2018-09-17) 8 | --------------------------- 9 | 10 | * Fixed ``render()`` kwargs for Django 2.1 11 | 12 | 13 | Changes in 0.9 (2016-08-07) 14 | --------------------------- 15 | 16 | * Marked Python 3 support. 17 | * Added support for django-filer_ fields. 18 | Note this means your database uses a different field type; a ``ForeignKey`` to it's models. 19 | Hence, this switch can only be done at the start of the project. 20 | 21 | 22 | Changes in version 0.8.2 23 | ------------------------ 24 | 25 | * Make ``ImagePreviewWidget`` compatible with ``Image`` objects without path attribute 26 | 27 | 28 | Changes in version 0.8.1 29 | ------------------------ 30 | 31 | * Fixed missing ``url`` property for images when using django-filebrowser-no-grappelli_ instead of Django's ``ImageField``. 32 | This patch is not applied for the django-filebrowser-no-grappelli-django14_ fork, which does provide an ``url`` property. 33 | * Fixed ``format`` setting for certain django-filebrowser forks. 34 | * Added warning to avoid using ``width_field`` and ``height_field`` because not all backends support those. 35 | * Point default filebrowser to https://github.com/smacker/django-filebrowser-no-grappelli-django14, 36 | so ``pip install django-any-imagefield[filebrowser]`` installs that version. 37 | 38 | 39 | Version 0.8.0 40 | ------------- 41 | 42 | Initial public release, extracted from the GitHub repository 43 | of ``django-cmsfields`` (nowadays https://github.com/edoburu/django-any-urlfield). 44 | 45 | * Support for django-filebrowser-no-grappelli_, which includes a preview and file selector. 46 | * Support for SORL-thumbnail_, which includes a preview 47 | * Support for Django's default ``ImageField``, with a preview added to it. 48 | 49 | .. _django-filebrowser-no-grappelli: https://github.com/wardi/django-filebrowser-no-grappelli 50 | .. _django-filebrowser-no-grappelli-django14: https://github.com/smacker/django-filebrowser-no-grappelli-django14 51 | .. _django-filer: https://github.com/divio/django-filer 52 | .. _SORL-thumbnail: https://github.com/sorl/sorl-thumbnail 53 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | # Windows note: folders should not end with a slash 2 | include AUTHORS 3 | include README.rst 4 | include CHANGES.rst 5 | include LICENSE 6 | recursive-include any_imagefield/templates/any_imagefield *.html 7 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | django-any-imagefield 2 | ===================== 3 | 4 | This module offers a abstraction over the various image fields, 5 | so allow third party applications can provide an imagefield at the project choice. 6 | 7 | Supported image fields: 8 | 9 | * django-filebrowser-no-grappelli_, which includes a preview and file selector. 10 | * django-filer_, which includes a preview and file selector. 11 | * SORL-thumbnail_, which includes a preview 12 | * Django's default ``ImageField``, with a preview added to it. 13 | 14 | 15 | Installation 16 | ============ 17 | 18 | First install the module, preferably in a virtual environment. It can be installed from PyPI:: 19 | 20 | pip install django-any-imagefield 21 | 22 | Configuration 23 | ------------- 24 | 25 | Add the module to the installed apps: 26 | 27 | .. code-block:: python 28 | 29 | INSTALLED_APPS += ( 30 | 'any_imagefield', 31 | ) 32 | 33 | Usage 34 | ----- 35 | 36 | In a Django model, the field can be included: 37 | 38 | .. code-block:: python 39 | 40 | from django.db import models 41 | from any_imagefield.models import AnyImageField 42 | 43 | class Article(models.Model): 44 | title = models.CharField("Title", max_length=200) 45 | image = AnyImageField("Image", upload_to='images') 46 | 47 | class Meta: 48 | verbose_name = "Article" 49 | verbose_name_plural = "Articles" 50 | 51 | def __unicode__(self): 52 | return self.title 53 | 54 | By default, the ``AnyImageField`` displays a standard ``ImageField`` with a preview thumbnail. 55 | When django-filebrowser-no-grappelli_ is installed, it will use the ``FileBrowseField`` from 56 | that package to display the file/image browser. When your package has it's own ``ImageField`` variant/subclass, 57 | please consider to add support for it in this package. 58 | 59 | 60 | Contributing 61 | ------------ 62 | 63 | This module is designed to be generic. In case there is anything you didn't like about it, 64 | or think it's not flexible enough, please let us know. We'd love to improve it! 65 | 66 | If you have any other valuable contribution, suggestion or idea, 67 | please let us know as well because we will look into it. 68 | Pull requests are welcome too. :-) 69 | 70 | 71 | .. _django-filebrowser-no-grappelli: https://github.com/smacker/django-filebrowser-no-grappelli 72 | .. _django-filer: https://github.com/stefanfoulis/django-filer 73 | .. _SORL-thumbnail: https://github.com/sorl/sorl-thumbnail 74 | -------------------------------------------------------------------------------- /any_imagefield/__init__.py: -------------------------------------------------------------------------------- 1 | # following PEP 440 2 | __version__ = "1.1" 3 | -------------------------------------------------------------------------------- /any_imagefield/forms/__init__.py: -------------------------------------------------------------------------------- 1 | from .fields import ImagePreviewField 2 | from .widgets import ImagePreviewWidget 3 | 4 | __all__ = ( 5 | 'ImagePreviewField', 6 | 'ImagePreviewWidget', 7 | ) 8 | -------------------------------------------------------------------------------- /any_imagefield/forms/fields.py: -------------------------------------------------------------------------------- 1 | """ 2 | Custom form fields for CMS items 3 | """ 4 | from django import forms 5 | from .widgets import ImagePreviewWidget 6 | 7 | 8 | class ImagePreviewField(forms.ImageField): 9 | """ 10 | An `~django.forms.widgets.ImageField` subclass that also displays an inline preview of the image. 11 | """ 12 | widget = ImagePreviewWidget 13 | -------------------------------------------------------------------------------- /any_imagefield/forms/widgets.py: -------------------------------------------------------------------------------- 1 | import mimetypes 2 | from django.contrib.admin.widgets import AdminFileWidget 3 | from django.template.loader import render_to_string 4 | 5 | 6 | class ImagePreviewWidget(AdminFileWidget): 7 | """ 8 | An :class:`~django.forms.FileInput` widget that also displays a preview of the image. 9 | """ 10 | template_with_initial = '%(clear_template)s
%(input_text)s: %(input)s'
11 |
12 | def render(self, name, value, *args, **kwargs):
13 | is_image = False
14 | if value:
15 | if hasattr(value, 'path'):
16 | (mime_type, encoding) = mimetypes.guess_type(value.path)
17 | else:
18 | # Try to guess mime_type from name alone, for remote FileSystems (S3, etc...)
19 | (mime_type, encoding) = mimetypes.guess_type(value.name)
20 | is_image = mime_type and mime_type.startswith('image/')
21 |
22 | # Render different field for replacing
23 | input_field = super().render(name, value, *args, **kwargs)
24 | if not value:
25 | return input_field
26 | else:
27 | return render_to_string("any_imagefield/imagepreviewwidget/update.html", {
28 | 'value': value,
29 | 'is_image': is_image,
30 | 'input_field': input_field,
31 | 'input_text': self.input_text,
32 | })
33 |
--------------------------------------------------------------------------------
/any_imagefield/models/__init__.py:
--------------------------------------------------------------------------------
1 | from .fields import AnyFileField, AnyImageField
2 |
3 | __all__ = (
4 | 'AnyFileField', 'AnyImageField',
5 | )
6 |
--------------------------------------------------------------------------------
/any_imagefield/models/backends/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/edoburu/django-any-imagefield/866bcdad6c87281587abc8a696561b1bee5719a1/any_imagefield/models/backends/__init__.py
--------------------------------------------------------------------------------
/any_imagefield/models/backends/default.py:
--------------------------------------------------------------------------------
1 | from django.db import models
2 |
3 |
4 | class AnyFileField(models.FileField):
5 | """
6 | The standard Django `~django.forms.FileField` with a `~django.forms.ClearableFileInput` widget.
7 | """
8 | pass
9 |
10 |
11 | class AnyImageField(models.ImageField):
12 | """
13 | The standard Django `~django.forms.ImageField` with a `~django.forms.ClearableFileInput` widget.
14 | """
15 | pass
16 |
--------------------------------------------------------------------------------
/any_imagefield/models/backends/filebrowser.py:
--------------------------------------------------------------------------------
1 | from filebrowser.fields import FileBrowseField, FileObject
2 | # The filebrowser can either be:
3 | # https://github.com/wardi/django-filebrowser-no-grappelli
4 | # https://github.com/smacker/django-filebrowser-no-grappelli-django14
5 |
6 |
7 | class PatchedFileObject(FileObject):
8 | @property
9 | def url(self):
10 | # The filebrowser returns a FileObject which differs from Django's FieldFile / ImageFieldFile object
11 | # Assign 'url' attribute for compatibility with
12 | return self.url_full
13 |
14 |
15 | class CompatibleFileBrowseField(FileBrowseField):
16 | """
17 | Internal class to fix compatibility between Django's native FileField
18 | and django-filebrowser's FileBrowseField
19 | """
20 |
21 | def to_python(self, value):
22 | value = super().to_python(value)
23 | if value.__class__ is FileObject and 'url' not in value.__class__.__dict__:
24 | value.__class__ = PatchedFileObject
25 | return value
26 |
27 |
28 | class AnyFileField(CompatibleFileBrowseField):
29 | """
30 | The file browse field based on django-filebrowser.
31 | """
32 | def __init__(self, *args, **kwargs):
33 | defaults = {
34 | 'max_length': 100, # Same as django FileField
35 | 'format': 'file',
36 | 'directory': kwargs.pop('upload_to', ''),
37 | }
38 |
39 | defaults.update(kwargs)
40 | super().__init__(*args, **defaults)
41 |
42 |
43 | class AnyImageField(CompatibleFileBrowseField):
44 | """
45 | The image browse field based on django-filebrowser.
46 | """
47 | def __init__(self, *args, **kwargs):
48 | defaults = {
49 | 'max_length': 100, # Same as django ImageField
50 | 'format': 'image', # lowercase is supported by both forks
51 | 'directory': kwargs.pop('upload_to', ''),
52 | }
53 |
54 | defaults.update(kwargs)
55 | super().__init__(*args, **defaults)
56 |
--------------------------------------------------------------------------------
/any_imagefield/models/backends/filer.py:
--------------------------------------------------------------------------------
1 | from filer.fields.image import FilerImageField
2 | from filer.fields.file import FilerFileField
3 |
4 |
5 | class AnyFileField(FilerFileField):
6 | """
7 | The file browse field based on django-filer.
8 | """
9 | def __init__(self, *args, **kwargs):
10 | super().__init__()
11 |
12 |
13 | class AnyImageField(FilerImageField):
14 | """
15 | The image browse field based on django-filer.
16 | """
17 | def __init__(self, *args, **kwargs):
18 | super().__init__()
19 |
--------------------------------------------------------------------------------
/any_imagefield/models/backends/preview.py:
--------------------------------------------------------------------------------
1 | from django.db import models
2 | from .default import AnyFileField
3 |
4 | __all__ = ('AnyFileField', 'AnyImageField')
5 |
6 |
7 | class AnyImageField(models.ImageField):
8 | """
9 | The standard Django `~django.forms.widgets.ImageField` with a preview.
10 | """
11 | def formfield(self, **kwargs):
12 | from any_imagefield.forms.fields import ImagePreviewField
13 | from any_imagefield.forms.widgets import ImagePreviewWidget
14 | kwargs['widget'] = ImagePreviewWidget # hard override for admin
15 | defaults = {'form_class': ImagePreviewField}
16 | defaults.update(kwargs)
17 | return super().formfield(**defaults)
18 |
--------------------------------------------------------------------------------
/any_imagefield/models/backends/sorl.py:
--------------------------------------------------------------------------------
1 | from django.db import models
2 | from django.utils.safestring import mark_safe
3 | from sorl.thumbnail.admin.current import AdminImageWidget
4 | from .default import AnyFileField # can export as-is.
5 |
6 | __all__ = ('AnyFileField', 'AnyImageField')
7 |
8 |
9 | class FixedSorlAdminImageWidget(AdminImageWidget):
10 | # Fix the layout in the SORL AdminImageWidget
11 | template_with_initial = '%(clear_template)s%(input_text)s: %(input)s'
12 | template_with_clear = '%(clear)s
'
13 |
14 | def render(self, name, value, attrs=None, renderer=None):
15 | # Make sure the help text is displayed below the widget.
16 | orig_output = super().render(name, value, attrs, renderer=renderer)
17 | return mark_safe(
18 | orig_output \
19 | + '
{# easy fix to enforce sizes #}
2 | {% if is_image %}{% else %}{{ value }}{% endif %}
3 | {{ input_field }}
4 |