Changeset 443

Timestamp:

2007-05-31 15:11:40 (1 year ago)

Author:

tdb01r

Message:

• Added doxygen configuration file
  
• Added menu_fulltexts option to generate a break down of 'fulltexts' per repository (very slow though)
  
• Fixed some documentation in the database classes
  

Files:

• trunk/www/html/Doxyfile (added)
• trunk/www/html/api (added)
• trunk/www/html/include/db_celestial.php (modified) (6 diffs)
• trunk/www/html/include/db_roar.php (modified) (1 diff)
• trunk/www/html/include/roar_api.php (modified) (1 diff)
• trunk/www/html/include/roardatabase.php (modified) (1 diff)
• trunk/www/html/index.php (modified) (1 diff)

trunk/www/html/include/db_celestial.php

@@ -1 +1 @@
-<?php
+
+function _sql_format_value($n) { return "`format` LIKE '".mysql_real_escape_string($n)."%'"; }
+
+/**
+ *
+ * @brief Query the fulltext data held on a repository.
+ *
+ */
-
-class Fulltext
@@ -6 +14 @@
-        var $repo;
-        var $id;
+
+        var $fulltext_formats = array(
+                "Portable Document Format",
+                "Rich Text Format",
+                "Microsoft Word for Windows Document",
+                "Postscript",
+                "OpenOffice Writer"
+        );
-
-        function Fulltext($dbh, $repo, $id)
@@ -42 +58 @@
-        }
-
+        /**
+         *
+         * @brief Get a summary table of all the formats contained in this repository.
+         *
+         * @return An array of two arrays.
+         *
+         * The first array is the name of the format. The second array is the number of files in that format.
+         * 
+         * A special entry is the '[No files found]' field, which is the total number of OAI records with no files recorded.
+         */
+
-        function formatSummary()
-        {
@@ -70 +97 @@
-        }
-
+        /**
+         *
+         * @brief Get a summary of all formats, but only count one format per OAI record
+         *
+         * @return array
+         *
+         * Returns an associative array with the following values filled in: fulltexts, documents and html.
+         * 
+         */
+
+        function recordsSummary()
+        {
+                $ftable = $this->table();
+                $repo = $this->repo;
+                $md = $repo->getOaiDc();
+                $mtable = $md->table();
+
+                $data = array();
+
+                // How many records have a fulltext attached
+                $query = mysql_query("SELECT COUNT(DISTINCT `record`) FROM $ftable")
+                        or trigger_error(mysql_query($this->dbh));
+                $line = mysql_fetch_array($query);
+                $data['fulltexts'] = $line[0];
+
+                // How many records have one of the normal documenty formats
+                $sql = "SELECT COUNT(DISTINCT `record`) FROM $ftable WHERE `format` LIKE 'Hypertext Markup Language%'";
+                $query = mysql_query($sql)
+                        or trigger_error(mysql_query($this->dbh));
+                $line = mysql_fetch_array($query);
+                $data['html'] = $line[0];
+
+                // How many records have an HTML record attached (this may get
+                // confused by other links, access denied pages etc.)
+                $sql = "SELECT COUNT(DISTINCT `record`) FROM $ftable WHERE ";
+                $formats = array_map("_sql_format_value", $this->fulltext_formats);
+                $sql .= implode(" OR ", $formats);
+                $query = mysql_query($sql)
+                        or trigger_error(mysql_query($this->dbh));
+                $line = mysql_fetch_array($query);
+                $data['documents'] = $line[0];
+
+                return $data;
+        }
+
-        function formatSummaryByYear()
-        {
@@ -125 +197 @@
-}
-
+/**
+ *
+ * @brief A Celestial repository
+ *
+ */
+
-class Repository
-{
@@ -144 +222 @@
-                return null;
-        }
+
+        /**
+         *
+         * @brief Gets an object to query fulltext data for this repository.
+         *
+         * @return A Fulltext object for this repository.
+         * 
+         */
-
-        function getFulltext()

trunk/www/html/include/db_roar.php

@@ -1 +1 @@
-<?php
+
+/**
+ *
+ * Creates the ROAR database object and provides some useful global methods
+ *
+ */
-
-include("roardatabase.php");

trunk/www/html/include/roar_api.php

@@ -2291 +2291 @@
-}
-
+/**
+ *
+ * Generate a summary table of detected repository fulltexts from Celestial
+ *
+ */
+
+function menu_fulltexts()
+{
+        global $DBH_ROAR, $DBH_CEL;
+
+        $ARCHIVES = $DBH_ROAR->read_archives( 'live' );
+
+        header("Content-type: text/plain");
+
+        foreach($ARCHIVES as $archive)
+        {
+                $archive_summary = array();
+                $archive_summary['name'] = $archive['name'];
+                $archive_summary['url'] = $archive['url'];
+                $archive_summary['records'] = isset($archive['recordcount']) ? $archive['recordcount'] : 0;
+                $archive_summary['fulltexts'] = $archive_summary['documents'] = $archive_summary['html'] = 0;
+
+                if( $archive_summary['records'] == 0 )
+                        continue;
+
+                foreach($archive['oai'] as $oai)
+                {
+                        if( !$DBH_CEL->hasProfile( $oai ) )
+                                continue;
+                        $repository = $DBH_CEL->getRepository( $oai );
+                        $format = $repository->getFulltext();
+
+                        $data = $format->recordsSummary();
+
+                        $archive_summary = array_merge( $archive_summary, $data );
+                }
+
+                foreach(array('records','fulltexts','documents','html','url','name') as $col)
+                {
+                        print $archive_summary[$col] . "\t";
+                }
+                print "\n";
+        }
+}
+
-function roar_done()
-{

trunk/www/html/include/roardatabase.php

@@ -2 +2 @@
-
-/**
-
+@brief 
- *
- * @author Tim Brody <tdb01r@ecs.soton.ac.uk>

trunk/www/html/index.php

@@ -65 +65 @@
-                break;
-        }
+        case "fulltexts": {
+                menu_fulltexts();
+                break;
+        }
-        case "google": {
-                menu_google();