root/gsdl/trunk/perllib/plugins/RealMediaPlugin.pm @ 16956

Revision 16956, 3.7 KB (checked in by ak19, 12 years ago)

Associated file names are url-encoded

  • Property svn:keywords set to Author Date Id Revision
Line 
1###########################################################################
2#
3# RealMediaPlugin.pm -- Extract metadata from Real Media files
4#
5# Original code by Xin Gao
6#
7# A component of the Greenstone digital library software
8# from the New Zealand Digital Library Project at the
9# University of Waikato, New Zealand.
10#
11# Copyright (C) 2005 New Zealand Digital Library Project
12#
13# This program is free software; you can redistribute it and/or modify
14# it under the terms of the GNU General Public License as published by
15# the Free Software Foundation; either version 2 of the License, or
16# (at your option) any later version.
17#
18# This program is distributed in the hope that it will be useful,
19# but WITHOUT ANY WARRANTY; without even the implied warranty of
20# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21# GNU General Public License for more details.
22#
23# You should have received a copy of the GNU General Public License
24# along with this program; if not, write to the Free Software
25# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26#
27###########################################################################
28
29package RealMediaPlugin;
30
31
32use BasePlugin;
33use rm::Header::PurePerl;
34
35use strict;
36no strict 'refs'; # make an exception so we can use variables as filehandles
37no strict 'subs';
38
39sub BEGIN {
40    @RealMediaPlugin::ISA = ('BasePlugin');
41}
42
43
44my $arguments =
45    [ { 'name' => "process_exp",
46    'desc' => "{BasePlugin.process_exp}",
47    'type' => "regexp",
48    'deft' => &get_default_process_exp(),
49    'reqd' => "no" } ];
50
51my $options = { 'name'     => "RealMediaPlugin",
52        'desc'     => "{RealMediaPlugin.desc}",
53        'abstract' => "no",
54        'inherits' => "yes",
55        'args'     => $arguments };
56
57
58# This plugin processes Real Media files with the suffixes ".rm" and ".rmvb"
59sub get_default_process_exp
60{
61    return q^(?i)(\.rm|rmvb)$^;
62}
63
64
65sub new
66{
67    my ($class) = shift(@_);
68    my ($pluginlist, $inputargs, $hashArgOptLists) = @_;
69    push(@$pluginlist, $class);
70
71    push(@{$hashArgOptLists->{"ArgList"}}, @{$arguments});
72    push(@{$hashArgOptLists->{"OptList"}}, $options);
73
74    my $self = new BasePlugin($pluginlist, $inputargs, $hashArgOptLists);
75   
76    return bless $self, $class;
77}
78
79sub process
80{
81    my $self = shift (@_);
82    my ($pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli) = @_;
83
84    my ($filename_full_path, $filename_no_path) = &util::get_full_filenames($base_dir, $file);
85    my $top_section = $doc_obj->get_top_section();
86    # prevent hashing: old code was in effect the following.
87    if ($doc_obj->{'OIDtype'} =~ /^hash$/) {
88    $doc_obj->set_OIDtype ("incremental");
89    }
90
91    my $text = "";
92    my $real_media = rm::Header::PurePerl->new($filename_full_path);
93    foreach my $key (keys %{$real_media->info})
94    {
95    my $value = $real_media->info->{$key};
96    $doc_obj->add_metadata($top_section, $key, $value);
97    $text .= "$key: $value\n";
98    }
99
100    $doc_obj->add_utf8_text($top_section, "<pre>\n$text\n</pre>");
101    $doc_obj->add_metadata($top_section, "FileFormat", "RealMedia");
102
103    $doc_obj->add_metadata($top_section, "srclink", "<a href=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[SourceFile]\">");
104    $doc_obj->add_metadata($top_section, "/srclink", "</a>");
105    # srcicon (need to include "irmvideo.gif" in the greenstone images directory
106    $doc_obj->add_metadata($top_section, "srcicon", "<img src=\"_httpprefix_/images/irmvideo.gif\" title=\"Download\" border=0>");
107
108    # Add the actual filename as it exists on the file system (URL-encoded) as an
109    # associated file by making sure we undo any escaped URL-encoding there may be
110    my $assoc_file = $doc_obj->get_assocfile_from_sourcefile(); # just url-encoded filename, no path
111    $doc_obj->associate_file($filename_full_path, $assoc_file, "RealMedia", $top_section);
112
113}
114
1151;
Note: See TracBrowser for help on using the browser.