doc/Deobfuscator/README

   1 Deobfuscator version 0.0.3
   2
   3 The Deobfuscator was written to make it easier to determine the methods that
   4 are available from a given BioPerl module.
   5
   6 BioPerl is a highly object-oriented software package, with often multiple
   7 levels of inheritance. Although each individual module is usually well
   8 documented for the methods specific to it, identifying the inherited methods
   9 is less straightforward.
  10
  11 The Deobfuscator indexes all of the BioPerl POD documentation, taking account
  12 of the inheritance tree, and then presents all of the methods available to
  13 each module through a searchable web interface.
  14
  15
  16 DOCUMENTATION
  17
  18 All of the code in this distribution have POD documentation, which can
  19 be read using the perldoc command. For example,
  20
  21     perldoc lib/Deobfuscator.pm
  22
  23 will show the POD documentation for the Deobfuscator module.
  24
  25 Also, there are two files in the cgi-bin directory which may be helpful:
  26
  27 cgi-bin/deob_help.html
  28 cgi-bin/deob_flowchart.png
  29
  30
  31 INSTALLATION
  32
  33 Installation of the Deobfuscator package requires a little bit more than a
  34 typical CPAN module because there are some cgi scripts, and these need to be
  35 placed in a directory accessible to a webserver.
  36
  37 Follow these steps to install the Deobfuscator on your system:
  38
  39 1) Follow the standard CPAN installation procedure to install the
  40 Deobfuscator.pm module and the deob_index.pl program.
  41
  42 Run the following commands:
  43
  44     perl Makefile.PL
  45     make
  46     make test
  47     make install
  48
  49
  50 Alternatively, to install with Module::Build, you can use the following commands:
  51
  52     perl Build.PL
  53     ./Build
  54     ./Build test
  55     ./Build install
  56
  57 2) Copy the contents of the cgi-bin directory to your cgi-bin directory, or
  58 any directory from which the webserver allows scripts to be executed over the
  59 web.
  60
  61 3) Make sure deob_interface.cgi and deob_detail.cgi are world-executable. On a
  62 UNIX system, the command
  63
  64     chmod o+x deob_interface.cgi deob_detail.cgi
  65
  66 should do it.
  67
  68 4) Run deob_index.pl. For a default installation, run it from your
  69 webserver's cgi-bin directory. On UNIX systems, it should be something
  70 like:
  71
  72         cd /Library/WebServer/CGI-Executables
  73     deob_index.pl /Library/Perl/5.8.6/Bio .
  74
  75 When the command finishes, it should show you some stats on the
  76 indexing. On my system it looked like this for BioPerl 1.5.1:
  77
  78 This indexing run found:
  79   803 files
  80   798 pkg_name
  81   772 desc
  82   788 synopsis
  83  5660 methods
  84
  85 If the number of files is much lower than this (like 0), then
  86 deob_index.pl may have been pointed to the wrong directory.
  87
  88 There should also be some new files in the directory you ran it from:
  89 packages.db
  90 methods.db
  91 package_list.txt
  92 deob_index.log
  93
  94 You can move or delete deob_index.log and the Deobfuscator should
  95 still work, but the other three files need to be in the same directory
  96 as deob_interface.cgi and deob_index.cgi unless you change the
  97 hardcoded variables in those scripts. See their documentation if you
  98 want to do that.
  99
 100 5) Test your installation by pointing your browser to the
 101 deob_interface.cgi script. On my system, the URL is:
 102
 103 http://localhost/cgi-bin/deob_interface.cgi
 104
 105 If you get an error, check the permissions on the cgi-scripts and the
 106 files that deob_index.pl created in the last step. Your webserver
 107 error log may also be helpful.
 108
 109 If you moved any of the files outside of your webserver's cgi-bin
 110 directory, make sure that the hardcoded variables in
 111 deob_interface.cgi point to their new location.
 112
 113 The BioPerl code itself (the modules) need to be in the @INC
 114 (PERL5LIB) of the user running the Deobfuscator
 115 itself. (Class::Inspector, used under the hood by the Deobfuscator,
 116 must be able to 'use' a module in order to find its methods.) You may
 117 need to add a 'use lib' directive at the beginning of
 118 deob_interface.cgi.
 119
 120 6) That should be it! As always, check the POD documentation in the
 121 individual files for more information. And if you have comments,
 122 suggesions, or problems, send an email to the BioPerl mailing list
 123 <bioperl-l@bioperl.org>.
 124
 125
 126 DEPENDENCIES
 127
 128 - version              Available from CPAN.
 129 - Class::Inspector     Available from CPAN.
 130 - Test::Pod            Available from CPAN.
 131 - BioPerl              Tested with v1.5.1, but other versions should work
 132                        too. Get the latest from http://www.bioperl.org.
 133
 134
 135 COPYRIGHT AND LICENSE
 136
 137 Copyright (C) 2006, Dave Messina and Laura Kavanaugh
 138
 139 This library is free software; you can redistribute it and/or modify
 140 it under the same terms as Perl itself.