Ignore .virtualenv

add FORCE_SCRIPT_NAME to host paperless on a subpath url

.gitignore

@@ -68,6 +68,7 @@ db.sqlite3
 .idea
 
 # Other stuff that doesn't belong
+.virtualenv
 virtualenv
 .vagrant
 docker-compose.yml

README.rst

@@ -140,5 +140,5 @@ work and they need the money a lot more than I do.
    :target: https://gitter.im/danielquinn/paperless?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
 .. |Travis| image:: https://travis-ci.org/danielquinn/paperless.svg?branch=master
    :target: https://travis-ci.org/danielquinn/paperless
-.. |Dependencies| image:: https://www.versioneye.com/user/projects/57b33b81d9f1b00016faa500/badge.svg?style=flat-square
+.. |Dependencies| image:: https://www.versioneye.com/user/projects/57b33b81d9f1b00016faa500/badge.svg
    :target: https://www.versioneye.com/user/projects/57b33b81d9f1b00016faa500

Vagrantfile

@@ -12,4 +12,9 @@ Vagrant.configure(VAGRANT_API_VERSION) do |config|
 
   # Networking details
   config.vm.network "private_network", ip: "172.28.128.4"
+
+  config.vm.provider "virtualbox" do |vb|
+    # Customize the amount of memory on the VM:
+    vb.memory = "1024"
+  end
 end

docs/changelog.rst

@@ -1,6 +1,16 @@
 Changelog
 #########
 
+* 0.7.0
+  * **Potentially breaking change**: As per `#235`_, Paperless will no longer
+    automatically delete documents attached to correspondents when those
+    correspondents are themselves deleted.  This was Django's default
+    behaviour, but didn't make much sense in Paperless' case.  Thanks to
+    `Thomas Brueggemann`_ and `David Martin`_ for their input on this one.
+  * Fix for `#232`_ wherein Paperless wasn't recognising ``.tif`` files
+    properly.  Thanks to `ayounggun`_ for reporting this one and to
+    `Kusti Skytén`_ for posting the correct solution in the Github issue.
+
 * 0.6.0
   * Abandon the shared-secret trick we were using for the POST API in favour
     of BasicAuth or Django session.
@@ -219,6 +229,8 @@ Changelog
 .. _David Martin: https://github.com/ddddavidmartin
 .. _Paperless Desktop: https://github.com/thomasbrueggemann/paperless-desktop
 .. _Joshua Gilman: https://github.com/jmgilman
+.. _ayounggun: https://github.com/ayounggun
+.. _Kusti Skytén: https://github.com/kskyten
 
 .. _#20: https://github.com/danielquinn/paperless/issues/20
 .. _#44: https://github.com/danielquinn/paperless/issues/44
@@ -256,5 +268,6 @@ Changelog
 .. _#228: https://github.com/danielquinn/paperless/pull/228
 .. _#229: https://github.com/danielquinn/paperless/pull/229
 .. _#230: https://github.com/danielquinn/paperless/pull/230
+.. _#232: https://github.com/danielquinn/paperless/issues/232
+.. _#235: https://github.com/danielquinn/paperless/issues/235
 .. _#236: https://github.com/danielquinn/paperless/issues/236
-

docs/setup.rst

@@ -394,7 +394,10 @@ Using a Real Webserver
 The default is to use Django's development server, as that's easy and does the
 job well enough on a home network.  However, if you want to do things right,
 it's probably a good idea to use a webserver capable of handling more than one
-thread.
+thread. You will also have to let the webserver serve the static files (CSS,
+JavaScript) from the directory configured in ``PAPERLESS_STATICDIR``. For that,
+you need to run ``./manage.py collectstatic`` in the ``src`` directory.  The
+default static files directory is ``../static``.
 
 Apache
 ~~~~~~
@@ -572,3 +575,28 @@ If you're using Docker, you can set a restart-policy_ in the
 Docker daemon.
 
 .. _restart-policy: https://docs.docker.com/engine/reference/commandline/run/#restart-policies-restart
+
+
+.. _setup-subdirectory
+
+Hosting Paperless in a Subdirectory
+-----------------------------------
+
+Paperless was designed to run off the root of the hosting domain,
+(ie: ``https://example.com/``) but with a few changes, you can configure
+it to run in a subdirectory on your server
+(ie: ``https://example.com/paperless/``).
+
+Thanks to the efforts of `maphy-psd`_ on `Github`_, running Paperless in a
+subdirectory is now as easy as setting a config variable.  Simply set
+``PAPERLESS_FORCE_SCRIPT_NAME`` in your environment or
+``/etc/paperless.conf`` to the path you want Paperless hosted at, configure
+Nginx/Apache for your needs and you're done.  So, if you want Paperless to live
+at ``https://example.com/arbitrary/path/to/paperless`` then you just set
+``PAPERLESS_FORCE_SCRIPT_NAME`` to ``/arbitrary/path/to/paperless``.  Note the
+leading ``/`` there.
+
+As to how to configure Nginx or Apache for this, that's on you :-)
+
+.. _maphy-psd: https://github.com/maphy-psd
+.. _Github: https://github.com/danielquinn/paperless/pull/255

paperless.conf.example

@@ -80,6 +80,11 @@ PAPERLESS_PASSPHRASE="secret"
 # as is "example.com,www.example.com", but NOT " example.com" or "example.com,"
 #PAPERLESS_ALLOWED_HOSTS="example.com,www.example.com"
 
+# To host paperless under a subpath url like example.com/paperless you set
+# this value to /paperless. No trailing slash!
+#
+# https://docs.djangoproject.com/en/1.11/ref/settings/#force-script-name
+#PAPERLESS_FORCE_SCRIPT_NAME=""
 
 ###############################################################################
 ####                          Software Tweaks                              ####
@@ -156,7 +161,9 @@ PAPERLESS_PASSPHRASE="secret"
 ####                            Interface                                  ####
 ###############################################################################
 
-# Override the default UTC time zone here
+# Override the default UTC time zone here.
+# See https://docs.djangoproject.com/en/1.10/ref/settings/#std:setting-TIME_ZONE
+# for details on how to set it.
 #PAPERLESS_TIME_ZONE=UTC
 
 

requirements.txt

@@ -1,4 +1,4 @@
-Django==1.10.5
+Django>=1.10,<1.11
 Pillow>=3.1.1
 django-crispy-forms>=1.6.1
 django-extensions>=1.7.6
@@ -13,12 +13,14 @@ python-dateutil>=2.6.0
 python-dotenv>=0.6.2
 python-gnupg>=0.3.9
 pytz>=2016.10
-gunicorn==19.6.0
+gunicorn==19.7.1
 
 # For the tests
+factory-boy
 pytest
 pytest-django
 pytest-sugar
+pytest-env
 pep8
 flake8
 tox

src/documents/admin.py

@@ -70,9 +70,14 @@ class DocumentAdmin(CommonAdmin):
     created_.short_description = "Created"
 
     def thumbnail(self, obj):
+        if settings.FORCE_SCRIPT_NAME:
+            src_link = "{}/fetch/thumb/{}".format(
+                settings.FORCE_SCRIPT_NAME, obj.id)
+        else:
+            src_link = "/fetch/thumb/{}".format(obj.id)
         png_img = self._html_tag(
             "img",
-            src="/fetch/thumb/{}".format(obj.id),
+            src=src_link,
             width=180,
             alt="Thumbnail of {}".format(obj.file_name),
             title=obj.file_name

src/documents/mail.py

@@ -165,7 +165,6 @@ class MailFetcher(Loggable):
         self._enabled = bool(self._host)
 
         self.last_checked = datetime.datetime.now()
-        print(self._connection, self._host, self._port, self._username, self._password, self._inbox, self._enabled, self.last_checked)
 
     def pull(self):
         """

src/documents/migrations/0012_auto_20160305_0040.py

@@ -38,6 +38,9 @@ class GnuPG(object):
 
 def move_documents_and_create_thumbnails(apps, schema_editor):
 
+    os.makedirs(os.path.join(settings.MEDIA_ROOT, "documents", "originals"), exist_ok=True)
+    os.makedirs(os.path.join(settings.MEDIA_ROOT, "documents", "thumbnails"), exist_ok=True)
+
     documents = os.listdir(os.path.join(settings.MEDIA_ROOT, "documents"))
 
     if set(documents) == {"originals", "thumbnails"}:

src/documents/migrations/0018_auto_20170715_1712.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.10.5 on 2017-07-15 17:12
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('documents', '0017_auto_20170512_0507'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='document',
+            name='correspondent',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='documents', to='documents.Correspondent'),
+        ),
+    ]

src/documents/models.py

@@ -172,7 +172,12 @@ class Document(models.Model):
     TYPES = (TYPE_PDF, TYPE_PNG, TYPE_JPG, TYPE_GIF, TYPE_TIF,)
 
     correspondent = models.ForeignKey(
-        Correspondent, blank=True, null=True, related_name="documents")
+        Correspondent,
+        blank=True,
+        null=True,
+        related_name="documents",
+        on_delete=models.SET_NULL
+    )
 
     title = models.CharField(max_length=128, blank=True, db_index=True)
 
@@ -316,45 +321,45 @@ class FileInfo(object):
             r"(?P<correspondent>.*) - "
             r"(?P<title>.*) - "
             r"(?P<tags>[a-z0-9\-,]*)"
-            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff)$",
+            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff?)$",
             flags=re.IGNORECASE
         )),
         ("created-title-tags", re.compile(
             r"^(?P<created>\d\d\d\d\d\d\d\d(\d\d\d\d\d\d)?Z) - "
             r"(?P<title>.*) - "
             r"(?P<tags>[a-z0-9\-,]*)"
-            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff)$",
+            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff?)$",
             flags=re.IGNORECASE
         )),
         ("created-correspondent-title", re.compile(
             r"^(?P<created>\d\d\d\d\d\d\d\d(\d\d\d\d\d\d)?Z) - "
             r"(?P<correspondent>.*) - "
             r"(?P<title>.*)"
-            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff)$",
+            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff?)$",
             flags=re.IGNORECASE
         )),
         ("created-title", re.compile(
             r"^(?P<created>\d\d\d\d\d\d\d\d(\d\d\d\d\d\d)?Z) - "
             r"(?P<title>.*)"
-            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff)$",
+            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff?)$",
             flags=re.IGNORECASE
         )),
         ("correspondent-title-tags", re.compile(
             r"(?P<correspondent>.*) - "
             r"(?P<title>.*) - "
             r"(?P<tags>[a-z0-9\-,]*)"
-            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff)$",
+            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff?)$",
             flags=re.IGNORECASE
         )),
         ("correspondent-title", re.compile(
             r"(?P<correspondent>.*) - "
             r"(?P<title>.*)?"
-            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff)$",
+            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff?)$",
             flags=re.IGNORECASE
         )),
         ("title", re.compile(
             r"(?P<title>.*)"
-            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff)$",
+            r"\.(?P<extension>pdf|jpe?g|png|gif|tiff?)$",
             flags=re.IGNORECASE
         ))
     ])
@@ -397,6 +402,8 @@ class FileInfo(object):
         r = extension.lower()
         if r == "jpeg":
             return "jpg"
+        if r == "tif":
+            return "tiff"
         return r
 
     @classmethod

src/documents/tests/factories.py

@@ -0,0 +1,17 @@
+import factory
+
+from ..models import Document, Correspondent
+
+
+class CorrespondentFactory(factory.DjangoModelFactory):
+
+    class Meta:
+        model = Correspondent
+
+    name = factory.Faker("name")
+
+
+class DocumentFactory(factory.DjangoModelFactory):
+
+    class Meta:
+        model = Document

src/documents/tests/test_consumer.py

@@ -58,9 +58,9 @@ class TestAttributes(TestCase):
 
     TAGS = ("tag1", "tag2", "tag3")
     EXTENSIONS = (
-        "pdf", "png", "jpg", "jpeg", "gif",
-        "PDF", "PNG", "JPG", "JPEG", "GIF",
-        "PdF", "PnG", "JpG", "JPeG", "GiF",
+        "pdf", "png", "jpg", "jpeg", "gif", "tiff", "tif",
+        "PDF", "PNG", "JPG", "JPEG", "GIF", "TIFF", "TIF",
+        "PdF", "PnG", "JpG", "JPeG", "GiF", "TiFf", "TiF",
     )
 
     def _test_guess_attributes_from_name(self, path, sender, title, tags):
@@ -80,6 +80,8 @@ class TestAttributes(TestCase):
             self.assertEqual(tuple([t.slug for t in file_info.tags]), tags, f)
             if extension.lower() == "jpeg":
                 self.assertEqual(file_info.extension, "jpg", f)
+            elif extension.lower() == "tif":
+                self.assertEqual(file_info.extension, "tiff", f)
             else:
                 self.assertEqual(file_info.extension, extension.lower(), f)
 

src/documents/tests/test_models.py

@@ -0,0 +1,31 @@
+from django.test import TestCase
+
+from ..models import Document, Correspondent
+from .factories import DocumentFactory, CorrespondentFactory
+
+
+class CorrespondentTestCase(TestCase):
+
+    def test___str__(self):
+        for s in ("test", "οχι", "test with fun_charÅc'\"terß"):
+            correspondent = CorrespondentFactory.create(name=s)
+            self.assertEqual(str(correspondent), s)
+
+
+class DocumentTestCase(TestCase):
+
+    def test_correspondent_deletion_does_not_cascade(self):
+
+        self.assertEqual(Correspondent.objects.all().count(), 0)
+        correspondent = CorrespondentFactory.create()
+        self.assertEqual(Correspondent.objects.all().count(), 1)
+
+        self.assertEqual(Document.objects.all().count(), 0)
+        DocumentFactory.create(correspondent=correspondent)
+        self.assertEqual(Document.objects.all().count(), 1)
+        self.assertIsNotNone(Document.objects.all().first().correspondent)
+
+        correspondent.delete()
+        self.assertEqual(Correspondent.objects.all().count(), 0)
+        self.assertEqual(Document.objects.all().count(), 1)
+        self.assertIsNone(Document.objects.all().first().correspondent)

src/paperless/settings.py

@@ -47,7 +47,8 @@ _allowed_hosts = os.getenv("PAPERLESS_ALLOWED_HOSTS")
 if _allowed_hosts:
     ALLOWED_HOSTS = _allowed_hosts.split(",")
 
-
+FORCE_SCRIPT_NAME = os.getenv("PAPERLESS_FORCE_SCRIPT_NAME")
+    
 # Application definition
 
 INSTALLED_APPS = [

src/paperless/version.py

@@ -1 +1 @@
-__version__ = (0, 6, 0)
+__version__ = (0, 6, 1)

src/pytest.ini

@@ -1,3 +1,7 @@
 [pytest]
 DJANGO_SETTINGS_MODULE=paperless.settings
-
+env =
+  PAPERLESS_CONSUME=/tmp
+  PAPERLESS_PASSPHRASE=THISISNOTASECRET
+  PAPERLESS_SECRET=paperless
+  PAPERLESS_EMAIL_SECRET=paperless

src/tox.ini

@@ -8,12 +8,8 @@ skipsdist = True
 envlist = py34, py35, py36, pep8
 
 [testenv]
-commands = {envpython} manage.py test
+commands = pytest
 deps = -r{toxinidir}/../requirements.txt
-setenv =
-    PAPERLESS_CONSUME=/tmp
-    PAPERLESS_PASSPHRASE=THISISNOTASECRET
-    PAPERLESS_SECRET=paperless
 
 [testenv:pep8]
 commands=pep8