Convert media processing backends to delete the queue directory (#254)
[mediagoblin.git] / mediagoblin / media_types / video / processing.py
index 4c44e65f593143a2f3c3367001f44606211dd9ca..68d14148af97aa281fd5f6ed4796cda2548e960d 100644 (file)
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import tempfile
+from tempfile import NamedTemporaryFile
 import logging
-import os
 
 from mediagoblin import mg_globals as mgg
-from mediagoblin.processing import create_pub_filepath
-from . import transcoders
+from mediagoblin.decorators import get_workbench
+from mediagoblin.processing import \
+    create_pub_filepath, FilenameBuilder, BaseProcessingFail, ProgressCallback
+from mediagoblin.tools.translate import lazy_pass_to_ugettext as _
 
-logging.basicConfig()
+from . import transcoders
 
 _log = logging.getLogger(__name__)
 _log.setLevel(logging.DEBUG)
 
 
+class VideoTranscodingFail(BaseProcessingFail):
+    '''
+    Error raised if video transcoding fails
+    '''
+    general_message = _(u'Video transcoding failed')
+
+
 def sniff_handler(media_file, **kw):
     transcoder = transcoders.VideoTranscoder()
     data = transcoder.discover(media_file.name)
@@ -44,85 +52,79 @@ def sniff_handler(media_file, **kw):
 
     return False
 
-
-def process_video(entry):
+@get_workbench
+def process_video(entry, workbench=None):
     """
     Process a video entry, transcode the queued media files (originals) and
     create a thumbnail for the entry.
+
+    A Workbench() represents a local tempory dir. It is automatically
+    cleaned up when this function exits.
     """
     video_config = mgg.global_config['media_type:mediagoblin.media_types.video']
 
-    workbench = mgg.workbench_manager.create_workbench()
-
     queued_filepath = entry.queued_media_file
     queued_filename = workbench.localized_file(
         mgg.queue_store, queued_filepath,
         'source')
+    name_builder = FilenameBuilder(queued_filename)
 
     medium_filepath = create_pub_filepath(
-        entry,
-        '{original}-640p.webm'.format(
-            original=os.path.splitext(
-                queued_filepath[-1])[0]  # Select the file name without .ext
-            ))
+        entry, name_builder.fill('{basename}-640p.webm'))
 
     thumbnail_filepath = create_pub_filepath(
-        entry, 'thumbnail.jpg')
-
-    # Create a temporary file for the video destination
-    tmp_dst = tempfile.NamedTemporaryFile()
+        entry, name_builder.fill('{basename}.thumbnail.jpg'))
 
+    # Create a temporary file for the video destination (cleaned up with workbench)
+    tmp_dst = NamedTemporaryFile(dir=workbench.dir, delete=False)
     with tmp_dst:
         # Transcode queued file to a VP8/vorbis file that fits in a 640x640 square
+        progress_callback = ProgressCallback(entry)
         transcoder = transcoders.VideoTranscoder()
-        transcoder.transcode(queued_filename, tmp_dst.name)
+        transcoder.transcode(queued_filename, tmp_dst.name,
+                vp8_quality=video_config['vp8_quality'],
+                vp8_threads=video_config['vp8_threads'],
+                vorbis_quality=video_config['vorbis_quality'],
+                progress_callback=progress_callback)
 
-        # Push transcoded video to public storage
-        _log.debug('Saving medium...')
-        mgg.public_store.get_file(medium_filepath, 'wb').write(
-            tmp_dst.read())
-        _log.debug('Saved medium')
+    # Push transcoded video to public storage
+    _log.debug('Saving medium...')
+    mgg.public_store.copy_local_to_storage(tmp_dst.name, medium_filepath)
+    _log.debug('Saved medium')
 
-        entry.media_files['webm_640'] = medium_filepath
+    entry.media_files['webm_640'] = medium_filepath
 
-        # Save the width and height of the transcoded video
-        entry.media_data['video'] = {
-            u'width': transcoder.dst_data.videowidth,
-            u'height': transcoder.dst_data.videoheight}
+    # Save the width and height of the transcoded video
+    entry.media_data_init(
+        width=transcoder.dst_data.videowidth,
+        height=transcoder.dst_data.videoheight)
 
-    # Create a temporary file for the video thumbnail
-    tmp_thumb = tempfile.NamedTemporaryFile()
+    # Temporary file for the video thumbnail (cleaned up with workbench)
+    tmp_thumb = NamedTemporaryFile(dir=workbench.dir, suffix='.jpg', delete=False)
 
     with tmp_thumb:
         # Create a thumbnail.jpg that fits in a 180x180 square
-        transcoders.VideoThumbnailer(queued_filename, tmp_thumb.name)
-
-        # Push the thumbnail to public storage
-        _log.debug('Saving thumbnail...')
-        mgg.public_store.get_file(thumbnail_filepath, 'wb').write(
-            tmp_thumb.read())
-        _log.debug('Saved thumbnail')
+        transcoders.VideoThumbnailerMarkII(
+                queued_filename,
+                tmp_thumb.name,
+                180)
 
-        entry.media_files['thumb'] = thumbnail_filepath
+    # Push the thumbnail to public storage
+    _log.debug('Saving thumbnail...')
+    mgg.public_store.copy_local_to_storage(tmp_thumb.name, thumbnail_filepath)
+    entry.media_files['thumb'] = thumbnail_filepath
 
     if video_config['keep_original']:
         # Push original file to public storage
-        queued_file = file(queued_filename, 'rb')
-
-        with queued_file:
-            original_filepath = create_pub_filepath(
-                entry,
-                queued_filepath[-1])
-
-            with mgg.public_store.get_file(original_filepath, 'wb') as \
-                    original_file:
-                _log.debug('Saving original...')
-                original_file.write(queued_file.read())
-                _log.debug('Saved original')
-
-                entry.media_files['original'] = original_filepath
-
-    mgg.queue_store.delete_file(queued_filepath)
-
-    # Save the MediaEntry
-    entry.save()
+        _log.debug('Saving original...')
+        original_filepath = create_pub_filepath(entry, queued_filepath[-1])
+        mgg.public_store.copy_local_to_storage(queued_filename, original_filepath)
+        entry.media_files['original'] = original_filepath
+
+    # Remove queued media file from storage and database.
+    # queued_filepath is in the task_id directory which should
+    # be removed too, but fail if the directory is not empty to be on
+    # the super-safe side.
+    mgg.queue_store.delete_file(queued_filepath)      # rm file
+    mgg.queue_store.delete_dir(queued_filepath[:-1])  # rm dir
+    entry.queued_media_file = []