Closes #232: Integrates preview generator feature

tracim/development.ini.base

 # You can set french as default language by uncommenting next line
 # lang = fr
 cache_dir = %(here)s/data
-preview_cache_dir = '/tmp/tracim/cache/previews/'
+preview_cache_dir = /tmp/tracim/cache/previews/
 beaker.session.key = tracim
 beaker.session.secret = 3283411b-1904-4554-b0e1-883863b53080
 

tracim/tracim/controllers/page.py

 import tg
+from tg import expose
+from tg import tmpl_context
 from preview_generator.manager import PreviewManager
-from tg import expose, tmpl_context
+
 from tracim.config.app_cfg import CFG
 from tracim.controllers import TIMRestController
 from tracim.lib.content import ContentApi
 
 __all__ = ['PagesController']
 
+
 class PagesController(TIMRestController):
 
     @expose()
         return 'all the pages of document {}'.format(file_id)
 
     @expose(content_type='image/jpeg')
-    def get_one(self, page_id: int, revision_id: int=None, *args, **kwargs):
+    def get_one(self,
+                page_id: str='-1',
+                revision_id: str=None,
+                size: int=300,
+                *args, **kwargs):
         file_id = int(tg.request.controller_state.routing_args.get('file_id'))
-
-        # For now it's done through database content
-        # but soon it'll be with disk access
-
+        page = int(page_id)
+        revision_id = int(revision_id) if revision_id != 'latest' else None
+        cache_path = CFG.get_instance().PREVIEW_CACHE
+        preview_manager = PreviewManager(cache_path, create_folder=True)
         user = tmpl_context.current_user
-        content_api = ContentApi(
-            user,
-            show_archived=True,
-            show_deleted=True,
-        )
+        content_api = ContentApi(user,
+                                 show_archived=True,
+                                 show_deleted=True)
         if revision_id:
             file_path = content_api.get_one_revision_filepath(revision_id)
         else:
             file = content_api.get_one(file_id, self._item_type)
             file_path = content_api.get_one_revision_filepath(file.revision_id)
-
-        cfg = CFG.get_instance()
-        cache_path = cfg.PREVIEW_CACHE
-
-        preview_manager = PreviewManager(cache_path, create_folder=True)
-        path = preview_manager.get_jpeg_preview(
-            file_path=file_path,
-            page=page_id,
-            height=500,
-            width=500
-        )
-
+        path = preview_manager.get_jpeg_preview(file_path=file_path,
+                                                page=page,
+                                                height=size,
+                                                width=size)
         with open(path, 'rb') as large:
             return large.read()
 
     @expose(content_type='image/jpeg')
-    def high_quality(self, page_id: int, *args, **kwargs):
-        file_id = int(tg.request.controller_state.routing_args.get('file_id'))
-
-        # For now it's done through database content
-        # but soon it'll be with disk access
-
-        user = tmpl_context.current_user
-        content_api = ContentApi(
-            user,
-            show_archived=True,
-            show_deleted=True,
-        )
-        file_name = content_api.get_one(file_id, self._item_type).file_name
-        cache_path = '/home/alexis/Pictures/cache/'
-
-        preview_manager = PreviewManager(cache_path, create_folder=True)
-        path = preview_manager.get_jpeg_preview(
-            file_path='/home/alexis/Pictures/cache/{}'.format(file_name),
-            page=page_id,
-            height=5000,
-            width=5000
-        )
-
-        with open(path, 'rb') as large:
-            return large.read()
+    def high_quality(self,
+                     page_id: str='-1',
+                     revision_id: int=None,
+                     size: int=1000,
+                     *args, **kwargs):
+        result = self.get_one(page_id=page_id,
+                              revision_id=revision_id,
+                              size=size,
+                              args=args,
+                              kwargs=kwargs)
+        return result
 
     @expose(content_type='application/pdf')
-    def download_pdf_full(self, *args, **kwargs):
-        file_id = int(tg.request.controller_state.routing_args.get('file_id'))
-
-        # For now it's done through database content
-        # but soon it'll be with disk access
-
-        user = tmpl_context.current_user
-        content_api = ContentApi(
-            user,
-            show_archived=True,
-            show_deleted=True,
-        )
-        file_name = content_api.get_one(file_id, self._item_type).file_name
-        cache_path = '/home/alexis/Pictures/cache/'
-
-        preview_manager = PreviewManager(cache_path, create_folder=True)
-        path = preview_manager.get_pdf_preview(
-            file_path='/home/alexis/Pictures/cache/{}'.format(file_name),
-        )
-
-        tg.response.headers['Content-Disposition'] = \
-            str('attachment; filename="{}"'.format(file_name))
-        with open(path, 'rb') as pdf:
-            return pdf.read()
+    def download_pdf_full(self,
+                          page_id: str,
+                          revision_id: str='-1',
+                          *args, **kwargs):
+        return self.download_pdf_one(page_id='-1',
+                                     revision_id=revision_id,
+                                     args=args, kwargs=kwargs)
 
     @expose(content_type='application/pdf')
-    def download_pdf_one(self, page_id: int, *args, **kwargs):
+    def download_pdf_one(self,
+                         page_id: str,
+                         revision_id: str=None,
+                         *args, **kwargs):
         file_id = int(tg.request.controller_state.routing_args.get('file_id'))
-        page_id = int(page_id)
-        # page_id = int(tg.request.controller_state.routing_args.get('page_id'))
-
-        # For now it's done through database content
-        # but soon it'll be with disk access
-
-        user = tmpl_context.current_user
-        content_api = ContentApi(
-            user,
-            show_archived=True,
-            show_deleted=True,
-        )
-        file_name = content_api.get_one(file_id, self._item_type).file_name
-
-        cache_path = '/home/alexis/Pictures/cache/'
-
+        revision_id = int(revision_id) if revision_id != 'latest' else None
+        page = int(page_id)
+        cache_path = CFG.get_instance().PREVIEW_CACHE
         preview_manager = PreviewManager(cache_path, create_folder=True)
-        path = preview_manager.get_pdf_preview(
-            file_path='/home/alexis/Pictures/cache/{}'.format(file_name),
-            page=page_id,
-        )
-
+        user = tmpl_context.current_user
+        content_api = ContentApi(user,
+                                 show_archived=True,
+                                 show_deleted=True)
+        file = content_api.get_one(file_id, self._item_type)
+        if revision_id:
+            file_path = content_api.get_one_revision_filepath(revision_id)
+        else:
+            file = content_api.get_one(file_id, self._item_type)
+            file_path = content_api.get_one_revision_filepath(file.revision_id)
+        path = preview_manager.get_pdf_preview(file_path=file_path,
+                                               page=page)
         tg.response.headers['Content-Disposition'] = \
-            str('attachment; filename="{}"'.format(file_name))
+            'attachment; filename="{}"'.format(file.file_name)
         with open(path, 'rb') as pdf:
             return pdf.read()
 

tracim/tracim/controllers/previews.py

+from tg import expose
+from tg import tmpl_context
+
 from tracim.controllers import TIMRestController
-from tg import expose, tmpl_context
 from tracim.controllers.page import PagesController
 
 __all__ = ['PreviewsController']
 
+
 class PreviewsController(TIMRestController):
 
     pages = PagesController()
 
     @expose()
-    def _default(self, *args, **kwargs):
+    def _default(self, *args, **kwargs) -> str:
         return '<h2> Error Loading Page</h2>'
 
     @expose()
-    def get_all(self, *args, **kwargs):
+    def get_all(self, *args, **kwargs) -> str:
         print('getall _ document')
         return 'all the files'
 
     @expose()
-    def get_one(self, file_id, *args, **kwargs):
+    def get_one(self, file_id: int, *args, **kwargs) -> str:
         print('getone _ document')
         tmpl_context.file = file_id
         return 'File n°{}'.format(file_id)

tracim/tracim/controllers/root.py

 # -*- coding: utf-8 -*-
-import tg
 from tg import expose
 from tg import flash
 from tg import lurl
 from tg import require
 from tg import tmpl_context
 from tg import url
-
 from tg.i18n import ugettext as _
-from tracim.controllers.api import APIController
-from tracim.controllers.content import ContentController
-from tracim.controllers.previews import PreviewsController
-
-from tracim.lib import CST
-from tracim.lib.base import logger
-from tracim.lib.user import CurrentUserGetterApi
-from tracim.lib.content import ContentApi
 
 from tracim.controllers import StandardController
 from tracim.controllers.admin import AdminController
+from tracim.controllers.api import APIController
+from tracim.controllers.calendar import CalendarConfigController
+from tracim.controllers.calendar import CalendarController
+from tracim.controllers.content import ContentController
 from tracim.controllers.debug import DebugController
 from tracim.controllers.error import ErrorController
 from tracim.controllers.help import HelpController
-from tracim.controllers.calendar import CalendarController
-from tracim.controllers.calendar import CalendarConfigController
+from tracim.controllers.previews import PreviewsController
 from tracim.controllers.user import UserRestController
 from tracim.controllers.workspace import UserWorkspaceRestController
+from tracim.lib import CST
+from tracim.lib.base import logger
+from tracim.lib.content import ContentApi
+from tracim.lib.user import CurrentUserGetterApi
 from tracim.lib.utils import replace_reset_password_templates
-
 from tracim.model.data import ContentType
-from tracim.model.serializers import DictLikeClass
-from tracim.model.serializers import CTX
 from tracim.model.serializers import Context
+from tracim.model.serializers import CTX
+from tracim.model.serializers import DictLikeClass
 
 
 class RootController(StandardController):
     debug = DebugController()
     error = ErrorController()
 
-
     # Rest controllers
     workspaces = UserWorkspaceRestController()
     user = UserRestController()
         super(RootController, self)._before(args, kw)
         tmpl_context.project_name = "tracim"
 
-
     @expose('tracim.templates.index')
     def index(self, came_from='', *args, **kwargs):
         if request.identity:
         logger.info(self, 'came_from: {}'.format(kwargs))
         return self.index(came_from, args, *kwargs)
 
-
     @expose()
     def post_login(self, came_from=lurl('/home')):
         """
         if not request.identity:
             login_counter = request.environ.get('repoze.who.logins', 0) + 1
             redirect(url('/login'),
-                params=dict(came_from=came_from, __logins=login_counter))
+                     params=dict(came_from=came_from, __logins=login_counter))
 
         user = CurrentUserGetterApi.get_current_user()
 
     @expose()
     def post_logout(self, came_from=lurl('/')):
         """
-        Redirect the user to the initially requested page on logout and say  goodbye as well.
+        Redirect the user to the initially requested page on logout and say
+        goodbye as well.
         """
         flash(_('Successfully logged out. We hope to see you soon!'))
         redirect(came_from)
-        
 
     @require(predicates.not_anonymous())
     @expose('tracim.templates.home')
         fake_api = Context(CTX.CURRENT_USER).toDict({
             'current_user': current_user_content})
 
-
         last_active_contents = ContentApi(user).get_last_active(None, ContentType.Any, None)
         fake_api.last_actives = Context(CTX.CONTENT_LIST).toDict(last_active_contents, 'contents', 'nb')
 
         #
         # return DictLikeClass(result = dictified_user, fake_api=fake_api)
 
-
     @require(predicates.not_anonymous())
     @expose('tracim.templates.search.display')
-    def search(self, keywords = ''):
+    def search(self, keywords=''):
         from tracim.lib.content import ContentApi
 
         user = tmpl_context.current_user
         search_results.keywords = keyword_list
 
         return DictLikeClass(fake_api=fake_api, search=search_results)
-
-

tracim/tracim/lib/content.py

 
         return revision
 
-    # def get_one_revision_file(self, revision_id: int = None):
-    #     """
-    #     This function allows us to directly get a Python file object from its
-    #     revision identifier.
-    #     :param revision_id: The revision id of the file we want to return
-    #     :return: The corresponding Python file object
-    #     """
-    #     revision = self.get_one_revision(revision_id)
-    #     return DepotManager.get().get(revision.depot_file_uid)
+    # def get_one_revision_file(self, revision_id: int = None):
+    #     """
+    #     This function allows us to directly get a Python file object from its
+    #     revision identifier.
+    #     :param revision_id: The revision id of the file we want to return
+    #     :return: The corresponding Python file object
+    #     """
+    #     revision = self.get_one_revision(revision_id)
+    #     return DepotManager.get().get(revision.depot_file_uid)
 
     def get_one_revision_filepath(self, revision_id: int = None) -> str:
         """
         revision = self.get_one_revision(revision_id)
 
         dpt = DepotManager.get()
-        # python 3.6 PEP 526 -- Syntax for Variable Annotations
-        # https://www.python.org/dev/peps/pep-0526/
-        # dpt_file_path: str = dpt.get(dpt_stored_file)._file_path
+        # python 3.6 PEP 526 -- Syntax for Variable Annotations
+        # https://www.python.org/dev/peps/pep-0526/
+        # dpt_file_path: str = dpt.get(dpt_stored_file)._file_path
         dpt_stored_file = dpt.get(revision.depot_file_uid)
         dpt_file_path = dpt.get(dpt_stored_file)._file_path
 

tracim/tracim/templates/file/getone.mak

     % endif
 
     <div class="content__detail file">
-        <div style="width: 15%;height: 100%;border:5px solid #606060;">
-            <a id="preview_link"><img id='preview' alt="Preview" style="width:100%;height:100%"></a>
-            <table style="width:100%;height:20%;">
-                <tr>
-                    <td rowspan="2">
-                        <button type="button" id="prev" onclick="previous_page()" style="width:100%;height:100%;"> - </button>
-                    </td>
-                    <td>
-                        <a id="dl_one_pdf" style=""> Download the page </a>
-                    </td>
-                    <td rowspan="2">
-                        <button type="button" id="next" onclick="next_page()" style="width:100%;height:100%;"> + </button>
-                    </td>
-                </tr>
-                <tr>
-                    <td >
-                        <a id="dl_full_pdf" style=""> Download all </a>
-                    </td>
-                </tr>
-            </table>
-
-            <script type="text/javascript">
-                var nb_page = parseInt(${nb_page});
-                console.log(nb_page);
-                var page = 0;
-                var urls = [];
-                % for one_url in url:
-                urls.push('${one_url}');
-                % endfor
-                console.log(urls);
-                document.getElementById('preview').src = urls[page];
-                refresh_button();
-
-                function next_page(){
-                    page = page+1;
-                    console.log('page next');
-                    console.log(urls[page]);
-                    document.getElementById('preview').src = urls[page];
-                    refresh_button();
-                }
-
-                function previous_page(){
-                    page = page-1;
-                    console.log('page previous');
-                    console.log(urls[page]);
-                    document.getElementById('preview').src = urls[page];
-                    refresh_button();
-                }
-
-                function refresh_button(){
-                    console.log(page);
-                    document.getElementById('prev').disabled = false;
-                    document.getElementById('next').disabled = false;
-                    document.getElementById('dl_one_pdf').href = "/previews/${result.file.id}/pages/" + page + "/download_pdf_one";
-                    document.getElementById('dl_full_pdf').href = "/previews/${result.file.id}/pages/" + page + "/download_pdf_full";
-                    document.getElementById('preview_link').href = "/previews/${result.file.id}/pages/" + page + "/high_quality";
-                    if(page >= nb_page-1){
-                        document.getElementById('next').disabled = true;
-                    }
-                    if(page <= 0){
-                        document.getElementById('prev').disabled = true;
-                    }
-                }
-            </script>
-        </div>
         <% download_url = tg.url('/workspaces/{}/folders/{}/files/{}/download?revision_id={}'.format(result.file.workspace.id, result.file.parent.id,result.file.id,result.file.selected_revision)) %>
         <div class="t-half-spacer-above download-file-button">
             <a style="" class="btn btn-default" tittle="${_('Download the file')}"
         <div class="t-half-spacer-above">
             <table class="table table-hover table-condensed table-striped table-bordered">
                 <tr>
+                    <td class="tracim-title">${_('Preview')}</td>
+                    <td>
+                        <table>
+                            <tr>
+                                <td>
+                                    <button type="button" id="prev" onclick="previous_page()">
+                                        <span class="pull-left">
+                                            ${ICON.FA_FW('fa fa-chevron-left')}
+                                        </span>
+                                    </button>
+                                </td>
+                                <td>
+                                    <a id="preview_link"><img id='preview' alt="Preview"></a>
+                                </td>
+                                <td>
+                                    <button type="button" id="next" onclick="next_page()">
+                                        <span>
+                                            ${ICON.FA_FW('fa fa-chevron-right')}
+                                        </span>
+                                    </button>
+                                </td>
+                                <td>
+                                    <a type="button" id="dl_one_pdf">${_('this page')}
+                                        <span class="pull-left">
+                                            ${ICON.FA_FW('fa fa-download')}
+                                        </span>
+                                    </a>
+                                </td>
+                                <td>
+                                    <a type="button" id="dl_full_pdf">${_('all pages')}
+                                        <span class="pull-left">
+                                            ${ICON.FA_FW('fa fa-download')}
+                                        </span>
+                                    </a>
+                                </td>
+                            </tr>
+                        </table>
+
+                        <script type="text/javascript">
+                            var nb_page = parseInt(${nb_page});
+                            console.log(nb_page);
+                            var page = 0;
+                            var urls = [];
+                            % for one_url in url:
+                            urls.push('${one_url}');
+                            % endfor
+                            console.log(urls);
+                            document.getElementById('preview').src = urls[page];
+                            refresh_button();
+
+                            function next_page(){
+                                page = page+1;
+                                console.log('page next');
+                                console.log(urls[page]);
+                                document.getElementById('preview').src = urls[page];
+                                refresh_button();
+                            }
+
+                            function previous_page(){
+                                page = page-1;
+                                console.log('page previous');
+                                console.log(urls[page]);
+                                document.getElementById('preview').src = urls[page];
+                                refresh_button();
+                            }
+
+                            function refresh_button(){
+                                console.log(page);
+                                document.getElementById('prev').disabled = false;
+                                document.getElementById('next').disabled = false;
+                                document.getElementById('dl_one_pdf').href = "/previews/${result.file.id}/pages/" + page + "/download_pdf_one?revision_id=${result.file.selected_revision}";
+                                document.getElementById('dl_full_pdf').href = "/previews/${result.file.id}/pages/" + page + "/download_pdf_full?revision_id=${result.file.selected_revision}";
+                                document.getElementById('preview_link').href = "/previews/${result.file.id}/pages/" + page + "/high_quality?revision_id=${result.file.selected_revision}";
+                                if(page >= nb_page-1){
+                                    document.getElementById('next').disabled = true;
+                                }
+                                if(page <= 0){
+                                    document.getElementById('prev').disabled = true;
+                                }
+                            }
+                        </script>
+                    </td>
+                </tr>
+                <tr>
                     <td class="tracim-title">${_('File')}</td>
                     <td>
                         <a href="${download_url}" tittle="${_('Download the file (last revision)')}">