Project

General

Profile

1 1929 brooke
 #
2
 #  '$RCSfile$'
3
 #  Copyright: 2000 Regents of the University of California
4
 #
5
 #   '$Author$'
6
 #     '$Date$'
7
 # '$Revision$'
8
 #
9
 # This program is free software; you can redistribute it and/or modify
10
 # it under the terms of the GNU General Public License as published by
11
 # the Free Software Foundation; either version 2 of the License, or
12
 # (at your option) any later version.
13
 #
14
 # This program is distributed in the hope that it will be useful,
15
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
 # GNU General Public License for more details.
18
 #
19
 # You should have received a copy of the GNU General Public License
20
 # along with this program; if not, write to the Free Software
21
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22
 #
23
24
package Metacat;
25
26
require 5.005_62;
27
use strict;
28
use warnings;
29
30
require Exporter;
31
use AutoLoader qw(AUTOLOAD);
32
33
use LWP::UserAgent;
34 3421 walbridge
use HTTP::Request::Common qw(POST);
35 1929 brooke
use HTTP::Cookies;
36
37
our @ISA = qw(Exporter);
38
39
# Items to export into callers namespace by default. Note: do not export
40
# names by default without a very good reason. Use EXPORT_OK instead.
41
# Do not simply export all your public functions/methods/constants.
42
43
# This allows declaration	use Metacat ':all';
44
# If you do not need this, moving things directly into @EXPORT or @EXPORT_OK
45
# will save memory.
46
our %EXPORT_TAGS = ( 'all' => [ qw(
47
48
) ] );
49
50
our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
51
52
our @EXPORT = qw(
53
54
);
55
our $VERSION = '0.01';
56
57
58
# Preloaded methods go here.
59
60
#############################################################
61
# Constructor creates a new class instance and inits all
62
# of the instance variables to their proper default values,
63
# which can later be changed using "set_options"
64
#############################################################
65
sub new {
66 3421 walbridge
  my($type,$metacatUrl) = @_;
67 1929 brooke
  my $cookie_jar = HTTP::Cookies->new;
68
69 3421 walbridge
  my $self = {
70
    metacatUrl     => $metacatUrl,
71 1929 brooke
    message        => '',
72
    cookies        => \$cookie_jar
73
  };
74
75 3421 walbridge
  bless $self, $type;
76
  return $self;
77 1929 brooke
}
78
79
#############################################################
80
# subroutine to set options for the class, including the URL
81
# for the Metacat database to which we would connect
82
#############################################################
83
sub set_options {
84
  my $self = shift;
85
  my %newargs = ( @_ );
86
87
  my $arg;
88
  foreach $arg (keys %newargs) {
89
    $self->{$arg} = $newargs{$arg};
90
  }
91
}
92
93
#############################################################
94
# subroutine to send data to metacat and get the response
95
# return response from metacat
96
#############################################################
97
sub sendData {
98
  my $self = shift;
99
  my %postData = ( @_ );
100
101 1955 jones
  $self->{'message'} = '';
102 1929 brooke
  my $userAgent = new LWP::UserAgent;
103
  $userAgent->agent("MetacatClient/1.0");
104 3421 walbridge
105
  # determine encoding type
106
  my $contentType = 'application/x-www-form-urlencoded';
107
  if ($postData{'enctype'}) {
108
      $contentType = $postData{'enctype'};
109
      delete $postData{'enctype'};
110
  }
111
112
  my $request = POST("$self->{'metacatUrl'}",
113
                     Content_Type => $contentType,
114
                     Content => \%postData
115
                );
116
117
  # set cookies on UA object
118 1929 brooke
  my $cookie_jar = $self->{'cookies'};
119
  $$cookie_jar->add_cookie_header($request);
120 5029 daigle
  #print "Content_type:text/html\n\n";
121 3421 walbridge
  #print "request: " . $request->as_string();
122 1929 brooke
123
  my $response = $userAgent->request($request);
124 3421 walbridge
  #print "response: " . $response->as_string();
125
126 1929 brooke
  if ($response->is_success) {
127
    # save the cookies
128
    $$cookie_jar->extract_cookies($response);
129
    # save the metacat response message
130
    $self->{'message'} = $response->content;
131
  } else {
132
    #print "SendData content is: ", $response->content, "\n";
133
    return 0;
134
  }
135
  return $response;
136
}
137
138
#############################################################
139
# subroutine to log into Metacat and save the cookie if the
140 2684 sgarg
# login is valid.  If not valid, return 0. If valid then send
141
# following values to indicate user status
142
# 1 - user
143
# 2 - moderator
144
# 3 - administrator
145
# 4 - moderator and administrator
146 1929 brooke
#############################################################
147
sub login {
148
  my $self = shift;
149
  my $username = shift;
150
  my $password = shift;
151
152
  my $returnval = 0;
153
154
  my %postData = ( action => 'login',
155
                   qformat => 'xml',
156
                   username => $username,
157
                   password => $password
158
                 );
159
  my $response = $self->sendData(%postData);
160
  if (($response) && $response->content =~ /<login>/) {
161
    $returnval = 1;
162
  }
163
164 2684 sgarg
  if (($response) && $response->content =~ /<isAdministrator>/) {
165
	if (($response) && $response->content =~ /<isModerator>/) {
166
    		$returnval = 4;
167
	} else {
168
		$returnval = 3;
169
	}
170
  } elsif (($response) && $response->content =~ /<isModerator>/){
171
	$returnval = 2;
172
  }
173
174 1929 brooke
  return $returnval;
175
}
176
177
#############################################################
178 5311 daigle
# subroutine to log into Metacat and get usr info xml for
179
# a logged in user
180
#############################################################
181
sub getUserInfo {
182
	my $self = shift;
183
184
	my %postData = (action => 'getloggedinuserinfo');
185
186
	my $response = $self->sendData(%postData);
187
188
	return $response->content;
189
}
190
191
#############################################################
192 1929 brooke
# subroutine to insert an XML document into Metacat
193
# If success, return 1, else return 0
194
#############################################################
195
sub insert {
196
  my $self = shift;
197
  my $docid = shift;
198
  my $xmldocument = shift;
199
  my $dtd = shift;
200
201
  my $returnval = 0;
202
203
  my %postData = ( action => 'insert',
204
                   docid => $docid,
205
                   doctext => $xmldocument
206
                 );
207
  if ($dtd) {
208
    $postData{'dtdtext'} = $dtd;
209
  }
210
211
  my $response = $self->sendData(%postData);
212
  if (($response) && $response->content =~ /<success>/) {
213
    $returnval = 1;
214
  } elsif (($response)) {
215
    $returnval = 0;
216
    #print "Error response from sendData!\n";
217
    #print $response->content, "\n";
218
  } else {
219
    $returnval = 0;
220
    #print "Invalid response from sendData!\n";
221
  }
222
223
  return $returnval;
224
}
225
226
#############################################################
227
# subroutine to update an XML document in Metacat
228
# If success, return 1, else return 0
229
#############################################################
230
sub update {
231
  my $self = shift;
232
  my $docid = shift;
233
  my $xmldocument = shift;
234
  my $dtd = shift;
235
236
  my $returnval = 0;
237
238
  my %postData = ( action => 'update',
239
                   docid => $docid,
240
                   doctext => $xmldocument
241
                 );
242
  if ($dtd) {
243
    $postData{'dtdtext'} = $dtd;
244
  }
245
246
  my $response = $self->sendData(%postData);
247
  if (($response) && $response->content =~ /<success>/) {
248
    $returnval = 1;
249
  }
250
251
  return $returnval;
252
}
253
254 3421 walbridge
############################################################
255
# subroutine to upload an XML document in Metacat
256
# If success, return 1, else return 0
257 1929 brooke
#############################################################
258 3421 walbridge
sub upload {
259
  my $self = shift;
260
  my $docid = shift;
261
  my $datafile = shift;
262
263
  my $returnval = 0;
264
265
  my %postData = ( action => 'upload',
266
                   docid => $docid,
267
                   datafile => [$datafile],
268
                   enctype => 'form-data'
269
                 );
270
271
  my $response = $self->sendData(%postData);
272
  #print "response is: $response";
273
  #
274
  if (($response) && $response->content =~ /<success>/) {
275
    $returnval = $response->content;
276
  }
277
278
  return $returnval;
279
}
280
281
282
#############################################################
283 1929 brooke
# subroutine to delete an XML document in Metacat
284
# If success, return 1, else return 0
285
#############################################################
286
sub delete {
287
  my $self = shift;
288
  my $docid = shift;
289
290
  my $returnval = 0;
291
292
  my %postData = ( action => 'delete',
293
                   docid => $docid
294
                 );
295
296
  my $response = $self->sendData(%postData);
297
  if (($response) && $response->content =~ /<success>/) {
298
    $returnval = 1;
299
  }
300
301
  return $returnval;
302
}
303
304
#############################################################
305 2846 sgarg
# subroutine to set access for an XML document in Metacat
306
# If success, return 1, else return 0
307
#############################################################
308
sub setaccess {
309
  my $self = shift;
310
  my $docid = shift;
311
  my $principal = shift;
312
  my $permission = shift;
313
  my $permType = shift;
314
  my $permOrder = shift;
315
316
  my $returnval = 0;
317
318
  my %postData = ( action => 'setaccess',
319
                   docid => $docid,
320
		   principal => $principal,
321
		   permission => $permission,
322
		   permType => $permType,
323
		   permOrder => $permOrder
324
                 );
325
326
  my $response = $self->sendData(%postData);
327
  if (($response) && $response->content =~ /<success>/) {
328
    $returnval = 1;
329
  }
330
331
  return $returnval;
332
}
333
334
335
#############################################################
336 1929 brooke
# subroutine to read an XML document from Metacat
337
# returns the XML from Metacat, which may be an error response
338
#############################################################
339
sub read {
340
  my $self = shift;
341
  my $docid = shift;
342
343
  my %postData = ( action => 'read',
344
                   qformat => 'xml',
345
                   docid => $docid
346
                 );
347
348
  my $response = $self->sendData(%postData);
349
350
  my $returnval = 0;
351
  if ($response) {
352
    $returnval = $response;
353
  }
354
355
  return $returnval;
356
}
357
358
#############################################################
359
# subroutine to query metacat using a structured path query
360
# returns the XML from Metacat, which may be an error response
361
#############################################################
362
sub squery {
363
  my $self = shift;
364
  my $query = shift;
365
366
  my %postData = ( action => 'squery',
367
                   qformat => 'xml',
368
                   query => $query
369
                 );
370
371
  my $response = $self->sendData(%postData);
372
373
  my $returnval = 0;
374
  if ($response) {
375
    $returnval = $response;
376
  }
377
378
  return $returnval;
379
}
380
381
#############################################################
382 1953 jones
# subroutine to get the maximimum id in a series
383
# If success, return max id, else return 0
384
#############################################################
385
sub getLastId {
386
  my $self = shift;
387
  my $scope = shift;
388
389
  my $returnval = 0;
390
391
  my %postData = ( action => 'getlastdocid',
392
                   scope => $scope
393
                 );
394
395
  my $response = $self->sendData(%postData);
396 5201 daigle
  if (($response) && $response->content =~  /<docid>(.*)<\/docid>/s) {
397 1953 jones
      $returnval = "$1";
398
  } elsif (($response)) {
399
    $returnval = 0;
400
    #print "Error response from sendData!\n";
401
    #print $response->content, "\n";
402
  } else {
403
    $returnval = 0;
404
    #print "Invalid response from sendData!\n";
405
  }
406
407
  return $returnval;
408
}
409 5201 daigle
410 1953 jones
#############################################################
411 5201 daigle
# subroutine to get the maximimum id in a series
412
# If success, return max id, else return 0
413
#############################################################
414
sub getLastRevision {
415
  my $self = shift;
416
  my $docid = shift;
417
418
  my $returnval = 0;
419
420
  my %postData = ( action => 'getrevisionanddoctype',
421
                   docid => $docid
422
                 );
423
424
  my $response = $self->sendData(%postData);
425
  if (($response) && $response->content =~ /(.*);(.*)/s)  {
426
      $returnval = "$1";
427
  } elsif (($response)) {
428
    $returnval = 0;
429
    #print "Error response from sendData!\n";
430
    #print $response->content, "\n";
431
  } else {
432
    $returnval = 0;
433
    #print "Invalid response from sendData!\n";
434
  }
435
436
  return $returnval;
437
}
438
439
#############################################################
440 7695 leinfelder
# subroutine to get the docid for a given PID
441
# If success, return docid, else return -1
442
#############################################################
443
sub getDocid {
444
  my $self = shift;
445
  my $pid = shift;
446
447
  my $returnval = 0;
448
449
  my %postData = ( action => 'getdocid',
450
                   pid => $pid
451
                 );
452
453
  my $response = $self->sendData(%postData);
454
  if (($response) && $response->content =~  /<docid>(.*)<\/docid>/s) {
455
      $returnval = "$1";
456
  } elsif (($response)) {
457
    $returnval = -1;
458
    #print "Error response from sendData!\n";
459
    #print $response->content, "\n";
460
  } else {
461
    $returnval = -1;
462
    #print "Invalid response from sendData!\n";
463
  }
464
465
  return $returnval;
466
}
467
468
#############################################################
469 1929 brooke
# subroutine to get the message returned from the last executed
470
# metacat action.  These are generally XML formatted messages.
471
#############################################################
472
sub getMessage {
473
  my $self = shift;
474
475
  return $self->{'message'};
476
}
477
478
#############################################################
479
# subroutine to get the cookies returned from the metacat
480
# server to establish (and pass on) session info (JSESSIONID).
481
#############################################################
482
sub getCookies {
483
  my $self = shift;
484
485
  return $self->{'cookies'};
486
}
487
488
# Autoload methods go after =cut, and are processed by the autosplit program.
489
490
1;
491
__END__
492
# Below is stub documentation for your module. You better edit it!
493
494
=head1 NAME
495
496
Metacat - Perl extension for communicating with the Metacat XML database
497
498
=head1 SYNOPSIS
499
500
  use Metacat;
501
  my $metacat = Metacat->new();
502
  my $response = $metacat->login($username, $password);
503
  print $metacat->getMessage();
504
  $response = $metacat->insert($docid, $xmldoc);
505
  print $metacat->getMessage();
506
  $response = $metacat->insert($docid, $xmldoc, $dtd);
507
  print $metacat->getMessage();
508
  $response = $metacat->update($docid, $xmldoc);
509
  print $metacat->getMessage();
510 3724 jones
  $response = $metacat->upload($docid, $data);
511
  print $metacat->getMessage();
512 1929 brooke
  $htmlResponse = $metacat->read($docid);
513
  $xmldoc = $htmlResponse->content();
514
  print $xmldoc;
515
  $resultset = $metacat->squery($pathquery);
516
  print $resultset;
517
  $response = $metacat->delete($docid);
518 2846 sgarg
  $response = $metacat->setaccess($docid,$principal,$permission,$permType,$permOrder);
519 1953 jones
  my $lastid = $metacat->getLastId("obfs");
520 1929 brooke
  print $metacat->getMessage();
521
  $response = $metacat->getCookies();
522
  print $metacat->getMessage();
523
524
=head1 DESCRIPTION
525
526
This is a client library for accessing the Metacat XML database.  Metacat
527
is a Java servlet that accepts commands over HTTP and returns XML and
528
HTML responses.  See http://knb.ecoinformatics.org for details about
529
Metacat and its interface.
530
531
=head2 EXPORT
532
533
None by default.
534
535
536
=head1 AUTHOR
537
538
Matthew B. Jones, jones@nceas.ucsb.edu
539
540
=head1 SEE ALSO
541
542
perl(1).
543
544
=cut