Note: This could also be a single long query but, we will make it a plugin for the purpose of example.

Version 1: I am a lawyer who wants a list of licenses for all the files in the repository with “debian” in the name. (actual code for this plugin is in trunk/devel/tutorials/ui-plugins/ui-debian-lics_v1.php)

• Query the db for all debian uploads; get the corresponding upload_pk (unique identifier for each upload) & uploadtree_pk (a tree that represents the directory structure of the upload). This requires joining two tables on the upload key. A direct query would look like this:

fossology=> SELECT uploadtree_pk, upload_pk, upload_filename FROM upload
  INNER JOIN uploadtree ON upload_fk=upload_pk AND parent IS NULL 
  WHERE upload_filename LIKE '%debian%';

In my case, I only have one debian upload.

• In my php plugin, the query above is stored in the variable $SQL and passed to the db for execution. The results of the query are passed back in the array $Results.

 $Results = $DB->Action($SQL);

• Next, loop thru the results and get every license for every file in this uploadtree. For this, we call the common function LicenseGetAll ( found in trunk/ui/common/common-license.php) and it returns the list of licenses in the array $Lics.

 foreach($Results as $Row)
    {
    if (empty($Row['upload_pk'])) { continue; }
    else { LicenseGetAll($Row[uploadtree_pk], $Lics); }
    ...
    }

• Sort the results and output to a table:

 arsort($Lics);
 foreach($Lics as $key => $value)
   <format table and output to UI>   (see the code for details)

Version 2: Using the previous example, make all the licenses “clickable” such that when they are clicked, they display all files with that license. This example will illustrate how to call a plugin from a plugin.

We need to check for the existence of the plugin (search_file_by_license) we wish to use. Use the function plugin_find_id found in the common code.

  if (plugin_find_id('search_file_by_license') >= 0)

Now, we simply make the license text a link that calls the plugin to locate all files with the given license. Change this line of code:

   "<tr><td>$key<td align='right'>$value\n";

To this:

   "<tr><td><a href='/repo/?mod=search_file_by_license&item=$Row[uploadtree_pk]
                    &lic=" . urlencode($key) . "'>$key</a>
        <td align='right'>$value\n"

Version 3: Use V2 but, prompt for the search string (i.e. remove hardcoded %debian%)

To add a prompt for the search string, we'll borrow a code snippet from an existing plugin, search-file.php. This code uses a function (GetParm) from the common code library to retrieve the search string safely and check it's data type.

      $Filename = GetParm("filename",PARM_STRING);
      $Uri = preg_replace("/&filename=[^&]*/","",Traceback());
 
      /* Prompt for the string to search for */
      $V .= "<form action='$Uri' method='POST'>\n";
      $V .= "<ul>\n";
      $V .= "<li>Enter the string to search for:<P>";
      $V .= "<INPUT type='text' name='filename' size='40' value='" . htmlentities ($Filename) . "'>\n";
      $V .= "</ul>\n";
      $V .= "<input type='submit' value='Search!'>\n";
      $V .= "</form>\n";

Check to see if we have string to search for and insert it into the SQL statement:

        if (!empty($Filename))
        {
          /* Get uploadtree_pk's for all debian uploads */
          $SQL = "SELECT uploadtree_pk, upload_pk, upload_filename 
                    FROM upload 
                    INNER JOIN uploadtree ON upload_fk=upload_pk AND parent IS NULL 
                    WHERE upload_filename LIKE '%$Filename%';";

The remaining code is as before in the previous version.