/usr/lib/slimrat/Plugin.pm is in slimrat-nox 1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 | # slimrat - plugin infrastructure
#
# Copyright (c) 2008-2009 Přemek Vyhnal
#
# This file is part of slimrat, an open-source Perl scripted
# command line and GUI utility for downloading files from
# several download providers.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# Authors:
# Tim Besard <tim-dot-besard-at-gmail-dot-com>
# Přemek Vyhnal <premysl.vyhnal gmail com>
#
#
# Configuration
#
# Package name
package Plugin;
# Packages
use threads;
use threads::shared;
use LWP::Simple;
use File::Basename;
# Find root for custom packages
use FindBin qw($RealBin);
use lib $RealBin;
# Custom packages
use Log;
use Configuration;
use Proxy;
# Write nicely
use strict;
use warnings;
# Static hashes
my %plugins;
my %details;
# Shared hashes
my %resources:shared;
my $per_plugin = "unaltered";
# Static reference for the global configuration object
my $config_global = new Configuration;
# Base configuration
my $config = new Configuration;
$config->set_default("update_server", "http://slimrat.googlecode.com/svn/tags/1.0/src/plugins");
$config->set_default("update_cache", $ENV{HOME}."/.slimrat/updates");
$config->section("all")->set_default("retry_count", 5);
$config->section("all")->set_default("retry_timer", 60);
#
# Object-oriented functionality
#
# Get an object
# Possible return values:
# 0 = object construction failed
# an object = success
sub new {
my ($class, $url, $mech, $no_lock) = @_;
$no_lock = 0 unless defined($no_lock);
fatal("cannot create plugin without configuration") unless ($config_global);
if (my $plugin = get_package($url)) {
# Resource handling
{
lock(%resources);
fatal("plugin $plugin did not set resources correctly") if (!defined($resources{$plugin}));
if ($resources{$plugin} >= 0) {
if ($resources{$plugin} == 0) {
debug("insufficient resources available");
if ($no_lock) {
return -1;
} else {
cond_wait(%resources) until $resources{$plugin} > 0;
}
}
$resources{$plugin}--;
debug("lowering available resources for plugin $plugin to ", $resources{$plugin});
}
}
# Configuration handling (propagate global plugin settings)
my $config_plugin = $config_global->section($plugin);
$config_plugin->merge($config);
# Construction
my $object = new $plugin ($config_plugin, $url, $mech);
return $object;
}
return 0;
}
# Destructor
sub DESTROY {
my ($self) = @_;
# Resource handling
my $plugin = ref($self);
lock(%resources);
if ($resources{$plugin} >= 0) {
$resources{$plugin}++;
debug("restoring available resources for plugin $plugin to ", $resources{$plugin});
}
}
# Return code
sub code {
my ($self) = @_;
return $self->{MECH}->status();
}
# Reload the page
sub reload {
my ($self) = @_;
my $res = $self->{MECH}->reload();
die("error reloading page, ", $self->{MECH}->status()) unless ($self->{MECH}->success());
dump_add(data => $self->{MECH}->content());
return $res;
}
# Get an URL
sub fetch($) {
my ($self, $url) = @_;
$url = $self->{URL} unless $url;
my $res = $self->{MECH}->get($url);
die("error reloading '$url', ", $self->{MECH}->status()) unless ($self->{MECH}->success());
dump_add(data => $self->{MECH}->content());
return $res;
}
#
# Static functionality
#
# Configure the plugin producer
sub configure {
my $complement = shift;
$config_global->merge($complement);
$config->merge($config_global->section("plugin"));
$config->path_abs("update_cache");
# Load plugins
load("$RealBin/plugins");
if (-d $config->get("update_cache")) {
load($config->get("update_cache"))
} else {
mkdir $config->get("update_cache") || warning("could not create update cache folder, updating plugins will not work");
}
execute();
fatal("no plugins loaded") unless ((scalar keys %plugins) || (scalar grep /plugins\/Direct\.pm$/, keys %INC)); # Direct doesnt register, so it isnt in %plugins
debug("loaded " . keys(%plugins) . " plugins (", join(", ", sort values %plugins), ")");
}
# Register a plugin
sub register {
$plugins{shift()}=(caller)[0];
}
# Provide instantes
sub provide {
$resources{(caller)[0]} = shift;
}
# Get a plugin's name
sub get_package {
(my $link) = @_;
foreach my $re (keys %plugins){
if($link =~ m#$re#i){
return $plugins{$re};
}
}
return "Direct";
}
# Update the plugins
sub update {
# Get BUILDS file from update server
my $builds = get($config->get("update_server") . "/BUILDS");
if ($builds) {
# Read builds
dump_add(title => "updater build list", data => $builds, type => "log");
my %builds;
$builds{$1} = $2 while ($builds =~ /^\s*([^#].*?)\s+(\d+)/gm);
# Compare builds
my $updates = 0;
foreach my $plugin (keys %details) {
if (!defined $builds{$plugin}) {
warning("update server does not provide resources for plugin '$plugin'");
next;
}
if (!defined($details{$plugin}) || $builds{$plugin} > $details{$plugin}{BUILD}) {
$updates++;
info("downloading update for $plugin");
# Download and install update
my $update = get($config->get("update_server") . "/$plugin");
if (! $update) {
error("could not update plugin '$plugin' (error fetching update)");
next;
}
elsif ($update =~ m/^##\s*BUILD\s+(.+)/m) {
dump_add(title => "update '$plugin'", data => $update, type => "pm");
if ($1 != $builds{$plugin}) {
error("could not update plugin '$plugin' (serverside build number mismatches)");
next;
}
open UPDATE, ">" . $config->get("update_cache") . "/$plugin";
if (!-w UPDATE) {
error("could not update plugin '$plugin' (plugin file not writable)");
next;
}
print UPDATE $update;
close UPDATE;
info("updated plugin '$plugin'");
}
else {
dump_add(title => "update '$plugin' (corrupt)", data => $update, type => "pm");
error("could not update plugin '$plugin', (update corrupt)");
next;
}
}
}
info("everything up to date already") if (!$updates);
} else {
return error("could not update plugins (error fetching builds list)");
}
}
# Load the plugins (dependancy check + execution)
sub load {
my $folder = shift;
# Process all plugins
my $counter = 0;
my @pluginfiles = <$folder/*.pm>;
LOOP: foreach my $plugin (@pluginfiles) {
# Quick parse
my %plugin_info = ();
open(PLUGIN, $plugin);
while (<PLUGIN>) {
chomp;
# Dependancy checking
if ((m/^\s*use (.+);/) and not (m/strict/ || m/warnings/)) {
eval;
if ($@) {
my $module = $1;
$module =~ s/ /, version >= /;
$module =~ s/;$//;
error("plugin '$plugin' shall not be used, due to unmet dependency $module");
next LOOP;
}
}
# Parse special instructions
elsif (m/^##\s*(\w+)\s+(.+)/) {
$plugin_info{$1} = $2;
}
}
close(PLUGIN);
if (!defined($plugin_info{BUILD})) {
error("plugin '", basename($plugin), "' did not specify build number");
next;
}
$plugin_info{PATH} = $plugin;
# Check versions
if (!defined($details{basename($plugin)})) {
$details{basename($plugin)} = \%plugin_info;
} elsif ($details{basename($plugin)}{BUILD} < $plugin_info{BUILD}) {
debug("replacing plugin '", basename($plugin), "' with newer version");
delete($details{basename($plugin)});
$details{basename($plugin)} = \%plugin_info;
}
$counter++;
}
return $counter;
}
# Execute all plugins (which effectively includes them in the active slimrat session)
sub execute {
foreach my $plugin (keys %details ) {
my $status = do $details{$plugin}{PATH};
if (!$status) {
if ($@) {
fatal("failed to parse plugin '$plugin' ($@)");
}
elsif ($!) {
fatal("failed to compile plugin '$plugin' ($!)");
}
else {
fatal("failed to load plugin '$plugin'");
}
next;
}
}
}
# Return
1;
#
# Documentation
#
=head1 NAME
Plugin
=head1 SYNOPSIS
use Plugin;
load_plugins();
# To be done in a plugin
register("TestPlugin", "http://www.TestSite.com");
# Should result in "TestPlugin"
my $pluginname = get_package("http://www.TestSite.com/download.php");
# Instantiates an object from package TestPlugin
my $plugin = Plugin::new("http://www.TestSite.com/download.php", $browser);
=head1 DESCRIPTION
Plugin manager, responsible for loading, checking, registering, and
dispatching plugins.
=head1 METHODS
=head2 Plugin::new($url, $mech, $no_lock)
Constructs a new object which is able to download the given URL. This object
is no instance of this package, but from a plugin which has been registered
to be able to process a given set of URLs.
$mech is the browser (WWW::Mechanize object) which shall be used to download
the file (upon the plugins get_data call).
When $no_lock is set, the construction return -1 when there are no resources
available, instead of lock automatically.
=head2 Plugin::configure($config)
Merges the local base config with a set of user-defined configuration
values.
=head2 Plugin::register($regex)
Should be called by plugins, registers itself to get called when the $regex
matches.
=head2 Plugin::get_package($url)
Get the package assigned with a given $url. This is for informational purposes, as
it does not instantiate an object of that type but merely does a lookup in the
internal datastructures.
=head2 Plugin::load_plugins()
Scans for plugins, checks their dependancies, and if met executes the plugin
file which subsequently should call Plugin::register() to get assigned with
a match of URLs.
=head1 AUTHOR
Přemek Vyhnal <premysl.vyhnal gmail com>
Tim Besard <tim-dot-besard-at-gmail-dot-com>
=cut
|