compiler.php

<?php
// Copyright: All contributers to the Umple Project
// This file is made available subject to the open source license found at:
// http://umple.org/license
//
// Invoked on the UmpleOnline server to cause one of the
// two jars to be run with appropriate arguments (umple.jar or umplesync.jar)
//
// Involed as an Ajax call by umple_action.js in the following places:
// Action.ajax - near the end of that file - for most compilation tasks
// Action.loadFile using ajax.js - argument load  - load a user saved file
// Action.loadExample - argument exampleCode - one of the pre-canned examples
// Action.saveNewFile using ajax.js - argument save 
// Action.pngImage, Action.ymlImageCallback
// Action.uiguCallback - argument asUI
//
// This file also formats the output from the jars for presentation back on
// the UmpleOnline screen
//
// Most of the helper methods are in compiler_config.php, except
// getErrorHtml, which reads the generated error file, and jsonDecode
//

require_once("compiler_config.php");

// Allow CORS so that any site may use the Umple compiler.
header("Access-Control-Allow-Origin: *");

if (isset($_REQUEST["save"]))
{
  if(isset($_REQUEST["svgContent"]))
  {
    $input = $_REQUEST["svgContent"];

    if(isset($_REQUEST["filename"]))
    {
      $filename = basename($_REQUEST['filename']);
      $modelId = dirname($_REQUEST['filename']);
      $dataHandle = dataStore()->openData($modelId);
      $dataHandle->writeData($filename, $input);
    }
    else
    {
      // this makes no sense, but mimic old behaviour for now
      $filename = 'model.ump';
      $dataHandle = dataStore()->createData();
      $dataHandle->writeData($filename, $input);
    }
    $workDir = $handleData->getWorkDir();
    // it will inserted into an href, so we should actually permalink
    // the resulting file
    echo $workDir->makePermalink($filename);
  }
  else
  {
    $input = $_REQUEST["umpleCode"];
    list($dataname, $dataHandle) = getOrCreateDataHandle();
    if (isset($_REQUEST["lock"]) && isset($_REQUEST["model"])){
      $model = $_REQUEST["model"];
      $lock_file = "../ump/".$model."/.lockfile";
      $fp = fopen($lock_file, "w");
      if (flock($fp, LOCK_EX)) {
        try {
          $dataHandle->writeData($dataname, $input);
        } catch (Exception $e) {
          // Do nothing for now here
        } finally {
          flock($fp, LOCK_UN);
        }
      }
    }
    else
    {
      $dataHandle->writeData($dataname, $input);
    }
    // pretend this is still the old system and mimic the kind of path
    // the JavaScript expects
    echo '../ump/'.$dataHandle->getName().'/'.$dataname;
  }
  
}
else if (isset($_REQUEST["load"]))
{
  // extract the model ID and filename from the old-style path
  $filename = basename($_REQUEST["filename"]);
  $modelId = basename(dirname($_REQUEST["filename"]));
  $dataHandle = dataStore()->openData($modelId);
  $outputUmple = $dataHandle->readData($filename);
  echo $outputUmple;
}
else if (isset($_REQUEST["action"]))
{
  handleUmpleTextChange();
}
else if (isset($_REQUEST["umpleCode"]))
{
  $input = $_REQUEST["umpleCode"];
  $fulllanguage = $_REQUEST["language"];
  
  // If there are suboptions in the language string, parse them out
  // Language stringh could be cpp or cpp.opt1.opt2.opt3
  $langparts = explode('.',$fulllanguage);
  $language = $langparts[0];
  $suboptions = "";
  for($i=1; $i<count($langparts); $i++){
    $suboptions = $suboptions . " -s " . $langparts[$i];
  }
  
  $languageStyle = isset($_REQUEST["languageStyle"])?
    $_REQUEST["languageStyle"] : false;
  $outputErr = isset($_REQUEST["error"])?$_REQUEST["error"]:false;
  $uigu = False;

  $javadoc = false;
  $stateDiagram = false;
  $featureDiagram = false;
  $classDiagram = false;
  $entityRelationshipDiagram = false;
  $yumlDiagram = false;
  $uigu = false;
  $Uigu2 = false;
  $htmlContents = false;
  $generatorType = "";
  
  //featureDiagram

  if ($language == "javadoc")
  {
     $language = "Java";
     $javadoc = True;
  }
  else if ($language == "stateDiagram")
  {
     $language = "GvStateDiagram";
     $generatorType = "";
     $stateDiagram = True;
  }
  else if ($language == "featureDiagram")
  {
      $language = "GvFeatureDiagram";
      $generatorType = "";
      $featureDiagram = True;
  }
  else if ($language == "classDiagram")
  {
     $language = "GvClassDiagram";
     $generatorType = "cd";     
     $classDiagram = True;
  }
  else if ($language == "traitDiagram")
  {
     $language = "GvClassTraitDiagram";
     $generatorType = "cdt";
     $classDiagram = True;
  }
  else if ($language == "entityRelationshipDiagram")
  {
     $language = "GvEntityRelationshipDiagram";
     $generatorType = "erd";
     $entityRelationshipDiagram = True;
  }
  else if ($language == "yumlDiagram")
  {
     $language = "Yuml";
     $yumlDiagram = True;
  }    
  else if ($language == "uigu")
  {
     $language = "Uigu";
     $uigu = True;
  }
  else if ($language == "Uigu2")
  {
    $Uigu2 = True;
    $htmlContents = True;
  }
  
  if ($languageStyle == "html")
  {
     $htmlContents = true;
  }
  
  if ($language == "Simulate")
  {
    list($dataname, $dataHandle) = getOrCreateDataHandle();
    $dataHandle->writeData($dataname, "generate Php \"./\" --override-all;\n" . $input);
    $workDir = $dataHandle->getWorkDir();
    $filename = $workDir->getPath().'/'.$dataname;
    executeCommand("java -jar umple.jar {$filename}");
    $workDir->saveModel();
    
    $dataHandle->writeData($dataname, "generate Simulate \"./\" --override-all;\n" . $input);
    $workDir = $dataHandle->getWorkDir();
    $filename = $workDir->getPath().'/'.$dataname;
    executeCommand("java -jar umple.jar {$filename}");
    $workDir->saveModel();
    // Restore file so it doesn't have the 'generate' command in front
    $dataHandle->writeData($dataname, $input);
    echo $dataHandle->getName();
    return;
  }
  elseif ($uigu)
  {
    list($dataname, $dataHandle) = getOrCreateDataHandle();
    $dataHandle->writeData($dataname, $input);
    $workDir = showUserInterface($dataname, $dataHandle);
/*  chdir("JSFProvider");
    if (file_exists("JSFProvider/model.ump"))
      unlink("JSFProvider/model.ump");
    copy("$filename", "JSFProvider/model.ump");
    executeCommand("java -cp GUIModel.jar;JSFProvider.jar;GUIGenerator.jar cruise.generator.UIGU UmpleProject.xml model.ump TempDir TempApp");*/
  }

  else if ($htmlContents) {
    list($dataname, $dataHandle) = getOrCreateDataHandle();
    $dataHandle->writeData($dataname, $input);
    $workDir = $dataHandle->getWorkDir();
    $filename = $workDir->getPath().'/'.$dataname;
    // note: this does not create the error output in the working directory, and likely never did
    $errorFilename = "{$filename}.erroroutput";
    $sourceCode = executeCommand("java -jar umplesync.jar -generate {$language} {$filename} 2> {$errorFilename}");
    $errors = getErrorHtml($errorFilename, 0);
    if($outputErr == "true")
      echo $errors . "<p>URL_SPLIT";
    $workDir->saveModel();
    if($Uigu2) {
       $uigu2dir = $workDir->getPath();
       if (!file_exists($uigu2dir."/app")) {
         symlink("../../scripts/uigu2/app",$uigu2dir."/app");
       }
       // exec("cd $uigu2dir; ln -s ../../scripts/uigu2/app .");    
       $uigu2file = $workDir->makePermalink('index.php');
       // DEBUG - to display as a link Uncomment the following line, and comment out the subsequent 4
       //  $html = "{$errhtml} <b> <a target=\"otherone\" href=\"" . $uigu2file . "\">$uigu2file</a> </b>";  
       $html = "
      <iframe width=100% height=1000 src=\"" . $uigu2file . "\">This browser does not
      support iframes, so the uigu cannot be displayed</iframe> 
      ";
       echo $html;
    }
    else {
      echo $sourceCode;
    }
    return;      
  } // end html content      

  elseif (!in_array($language,array("Php","Java","Ruby","RTCpp","Cpp","Sql","GvFeatureDiagram","GvStateDiagram","GvClassDiagram","GvEntityRelationshipDiagram","GvClassTraitDiagram","Yuml")))
  {  // If NOT one of the basic languages, then use umplesync.jar
    list($dataname, $dataHandle) = getOrCreateDataHandle();
    $dataHandle->writeData($dataname, $input);
    $workDir = $dataHandle->getWorkDir();
    $filename = $workDir->getPath().'/'.$dataname;
    $errorFilename = "{$filename}.erroroutput";
    
    if ($language == "Experimental-Cpp" || $language == "Experimental-Sql") {
      $sourceCode = executeCommand("echo \"{$language} is under development. Output is currently only available to developers of Umple\" 2> {$errorFilename}");
    }
    else {
      $sourceCode = executeCommand("java -jar umplesync.jar -generate {$language} {$filename} 2> {$errorFilename}");
    }
    $errors = getErrorHtml($errorFilename, 0);
    
    if ($language != "Json" && $language != "JsonMixed")
    {
      $sourceCode = htmlspecialchars($sourceCode);
    }
    
    if($outputErr == "true")
        echo $errors ."<p>URL_SPLIT";

    $workDir->saveModel();
    echo $sourceCode;
    return;
  }

  if (!$uigu)
  { // NOTuigu
  // Generate the Java, PHP, RTCpp, Ruby, Cpp or Sql and put it into the right directory
  list($dataname, $dataHandle) = getOrCreateDataHandle();
  $dataHandle->writeData($dataname, "generate {$language} \"./{$language}/\" --override-all;\n" . $input);
  $workDir = $dataHandle->getWorkDir();
  $filename = $workDir->getPath().'/'.$dataname;
  
  $outputFilename = "{$filename}.output";
  $errorFilename = "{$filename}.erroroutput";
  
  // Clean up any pre-existing java. php, RTCpp, ruby or cpp files
  $thedir = dirname($outputFilename);
  $toRemove = False;
  $rmcommand = "rm -rf ";
  foreach (glob("$thedir/{$language}") as $afile) {
    $rmcommand = $rmcommand . " " . $afile;
    $toRemove = True;
  }    
  if($toRemove) { exec($rmcommand); }
  
  // The following is a hack. The arguments to umplesync need fixing
  if (!$stateDiagram && !$classDiagram && !$entityRelationshipDiagram && !$yumlDiagram && !$featureDiagram) {  
    $command = "java -jar umplesync.jar -source {$filename} 2> {$errorFilename}";
  }
  else {
      // The following is used for outputting diagrams only
      $thedir = dirname($outputFilename);
      exec("rm -rf " . $thedir . "/modelcd.gv " . $thedir . "/model.gv " . $thedir . "modelcdt.gv " . $thedir . "/modelerd.gv");
      $command = "java -jar umplesync.jar -generate " . $language . " {$filename} " . $suboptions . " 2> {$errorFilename}";
  }
  // Took off 1> {$outputFilename}  in two commands above
  $resultFromCommand = executeCommand($command);

  $dataHandle->writeData(basename($outputFilename), $resultFromCommand);
  //exec("( ulimit -t 10; " . $command . ")");
  
  // Restore file so it doesn't have the 'generate' command in front
  $dataHandle->writeData($dataname, $input);
  
  $sourceCode = $resultFromCommand;
  
  $sourceCode = str_replace("<?php","",$sourceCode);
  $sourceCode = str_replace("?>","",$sourceCode);
  $sourceCode = htmlspecialchars($sourceCode);
  
  $errhtml = getErrorHtml($errorFilename);
  
  if ($sourceCode == "")
  {
    if($input == "//$?[End_of_model]$?") {
      $html = "
        Please create an Umple model textually (on the left side of the screen)
        or visually (on the right side of the screen),
        and then choose Generate Code again.";
    }
    else
    {
      $html = "
        An error occurred interpreting your Umple code, please review it and try again.
        If the problem persists, please email the Umple code to
        the umple-help google group: umple-help@googlegroups.com";
    }
    echo $errhtml ."<p>URL_SPLIT" . $html;
    
  }
  else
  {
    if ($javadoc)
    {
       $thedir = dirname($outputFilename);
       exec("rm -rf " . $thedir . "/javadoc");

        $command = "javadoc -d " . $thedir . "/javadoc -footer \"Generated by Umple\" " ;
              
      foreach (glob("$thedir/{$language}/*/*/*/*.java") as $afile) {
          $command = $command . " " . $afile;
       }
       
       foreach (glob("$thedir/{$language}/*/*/*.java") as $afile) {
          $command = $command . " " . $afile;
       }    
       
       foreach (glob("$thedir/{$language}/*/*.java") as $afile) {
          $command = $command . " " . $afile;
       }    
       
       foreach (glob("$thedir/{$language}/*.java") as $afile) {
          $command = $command . " " . $afile;
       }                  
       
       exec($command);
       exec("cd $thedir; rm javadocFromUmple.zip; zip -r javadocFromUmple javadoc");
       
       $javadocdir = $workDir->makePermalink('javadoc/');
       $javadoczip = $workDir->makePermalink('javadocFromUmple.zip');
       $html = "<a href=\"{$javadoczip}\">Download the following as a zip file</a>&nbsp;{$errhtml}
      <iframe width=100% height=1000 src=\"" . $javadocdir . "\">This browser does not
      support iframes, so the javadoc cannot be displayed</iframe> 
     ";
       echo $html;
    }  // end javadoc
    
    else if ($stateDiagram) {
      $thedir = dirname($outputFilename);
      exec("rm -rf " . $thedir . "/stateDiagram.svg");
      $command = "dot -Tsvg -Gdpi=63 " . $thedir . "/model.gv -o " . $thedir .  "/stateDiagram.svg"; 
      exec($command);
            if (!file_exists($thedir . "/stateDiagram.svg") && file_exists("doterr.svg"))
            {
                exec("cp " . "./doterr.svg " . $thedir . "/stateDiagram.svg");
            }
      $svgcode = readTemporaryFile("{$thedir}/stateDiagram.svg");
      $svglink = $workDir->makePermalink('stateDiagram.svg');
      $html = "<a href=\"umpleonline/$thedir/model.gv\">Download the GraphViz file for the following</a>&nbsp;<a href=\"$svglink\">Download the SVG file for the following</a>&nbsp;<br/>{$errhtml}&nbsp;
      <svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" height=\"2000\" width=\"2000\">";
      echo $html;
      echo $svgcode;
      echo "</svg>"; 
    } // end state diagram

    else if ($featureDiagram) {
      $thedir = dirname($outputFilename);
      exec("rm -rf " . $thedir . "/featureDiagram.svg");
      $command = "dot -Tsvg -Gdpi=63 " . $thedir . "/modelGvFeatureDiagram.gv -o " . $thedir .  "/featureDiagram.svg";
      exec($command);
      if (!file_exists($thedir . "/featureDiagram.svg") && file_exists("doterr.svg"))
      {
        exec("cp " . "./doterr.svg " . $thedir . "/featureDiagram.svg");
      }
      $svgcode = readTemporaryFile("{$thedir}/featureDiagram.svg");
      $svglink = $workDir->makePermalink('featureDiagram.svg');
      
      $html = "<a href=\featureDiagram.svg\">Download the GraphViz file for the following</a>&nbsp;<a href=\"$svglink\">Download the SVG file for the following</a>&nbsp;<br/>{$errhtml}&nbsp;
      <svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" height=\"2000\" width=\"2000\">";
      echo $html;
      echo $svgcode;
      echo "</svg>";   
    }
    
    else if ($classDiagram) {
      $thedir = dirname($outputFilename);
      exec("rm -rf " . $thedir . "/classDiagram.svg");
      $command = "dot -Tsvg -Gdpi=63 " . $thedir . "/model" . $generatorType . ".gv -o " . $thedir .  "/classDiagram.svg";
      exec($command);
            if (!file_exists($thedir . "/classDiagram.svg") && file_exists("doterr.svg"))
            {
                exec("cp " . "./doterr.svg " . $thedir . "/classDiagram.svg");
            }
      $svgcode = readTemporaryFile("{$thedir}/classDiagram.svg");
      $gvlink = $workDir->makePermalink('model'.$generatorType.'.gv');
      $svglink = $workDir->makePermalink('classDiagram.svg');
      $html = "<a href=\"$gvlink\">Download the GraphViz file for the following</a>&nbsp;<a href=\"$svglink\">Download the SVG file for the following</a>&nbsp;<br/>{$errhtml}&nbsp;
      <svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" height=\"2000\" width=\"2000\">";
      echo $html;
      echo $svgcode;
      echo "</svg>";      
    } // end graphViz class diagram

    else if ($entityRelationshipDiagram) {
      $thedir = dirname($outputFilename);
      exec("rm -rf " . $thedir . "/entityRelationshipDiagram.svg");
      $command = "dot -Tsvg -Gdpi=63 " . $thedir . "/modelerd.gv -o " . $thedir .  "/entityRelationshipDiagram.svg";
      exec($command);
      if (!file_exists($thedir . "/entityRelationshipDiagram.svg") && file_exists("doterr.svg"))
      {
        exec("cp " . "./doterr.svg " . $thedir . "/entityRelationshipDiagram.svg");
      }
      $svgcode = readTemporaryFile("{$thedir}/entityRelationshipDiagram.svg");
      $gvlink = $workDir->makePermalink('modelerd.gv');
      $erdiagramlink = $workDir->makePermalink('entityRelationshipDiagram.svg');
      $html = "<a href=\"$gvlink\">Download the GraphViz file for the following</a>&nbsp;<a href=\"$erdiagramlink\">Download the SVG file for the following</a>&nbsp;<br/>{$errhtml}&nbsp;
      <svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" height=\"2000\" width=\"2000\">";
      echo $html;
      echo $svgcode;
      echo "</svg>";      
    } // end graphViz entity relationship diagram
    
    else if ($yumlDiagram) {
      $thedir = dirname($outputFilename);
      exec("rm -rf " . $thedir . "/yuml.txt");
      copy($thedir . "/model.ump.output", $thedir .  "/yuml.txt");
      $command = "python yuml.py -i " . $thedir . "/yuml.txt -o " . $thedir .  "/yuml.png -s plain ";   
      $res = shell_exec($command . " 2>&1");           
      $yumllink = $workDir->makePermalink('yuml.txt');
      $imglink = $workDir->makePermalink('yuml.png');
      
      if (file_exists($thedir . "/yuml.png"))
      {
        $dltext = "&nbsp;<a href=\"$imglink\">Download the PNG file for the image</a>&nbsp;<br/>
      <img src=\"$imglink\"\>";
      }
      else
      {
        // could not generate either because of Python problem
        // or the yuml server not delivering because it doesn't like automated systems
        $yumltxt = file_get_contents($thedir."/yuml.txt");        
        $dltext = "&nbsp;<a target=\"yumlimg\" href=\"http://yuml.me/diagram/plain/class/".urlencode($yumltxt).".php\"> Click on this link to display the png in a different Tab (yuml.me doesn't like automated systems generating their images)</a>&nbsp;";
      }  

      $html = "<a href=\"$yumllink\">Download the Yuml text for the yuml image</a>. You can then use this text to generate various image formats at <a target=\"yumlimg\" href=\"https://yuml.me/diagram/plain/class/draw\">yuml.me</a>&nbsp;<br/>$dltext";
      echo $html;
    } // end yuml diagram  

    else // This is where the Java, PHP and other output is placed on the screen
    {
       exec("cd $thedir; rm {$language}FromUmple.zip; zip -r {$language}FromUmple {$language}");
       $archivelink = $workDir->makePermalink($language.'FromUmple.zip');
       echo "<a href=\"$archivelink\" class=\"zipDownloadLink\">Download the following as a zip file</a>&nbsp;{$errhtml}<p>URL_SPLIT";
       echo $sourceCode;
    }
  }
  } // end not UIGU
  else
  {  // is UIGU
    // variables here come from the uigu clause in the previous if statement
    // for all relative paths we assume we are chdir'd into a specific directory by showUserInterface
    $theurldir = $workDir->getPath();
    $filename = $theurldir.'/'.$dataname;
    $errorFilename = "{$filename}.erroroutput";
    $errhtml = getErrorHtml($errorFilename);
    $uiguDir=file_get_contents("uigudir.txt");
    $uiguIframe = $workDir->makePermalink('');
    $warlink = $workDir->makePermalink('umpleUIGU.war');
    $html = "<a href=\"$warlink\">Download the generated application as web archive (WAR) file.</a>&nbsp;{$errhtml}
      <iframe width=100% height=300 src='$uiguIframe/'></iframe>
     ";
     echo $html;
  }
}  // end request has umpleCode
else if (isset($_REQUEST["exampleCode"]))
{
  $filename = rootDir()."/ump/" . $_REQUEST["exampleCode"];
  $outputUmple = readTemporaryFile($filename);
  echo $outputUmple;
}
else if (isset($_REQUEST["asImage"]))
{
  $asImage = $_REQUEST["asImage"];
  $json = json_decode($asImage);
  showUmlImage($json);
}
else if (isset($_REQUEST["asYuml"]))
{
  showYumlImage($_REQUEST["asYuml"]);
}
else if (isset($_REQUEST["asUI"]))
{ 
  showUserInterface($_REQUEST["asUI"]);
}
else
{
  echo "Invalid use of compiler";
}


function getErrorHtml($errorFilename, $offset = 1) 
{
    
  $errorMessage = readTemporaryFile($errorFilename);

  if($errorMessage != "") 
  {
     savefile("",$errorFilename); // Clean error so it is gone for next time
     $errInfo = jsonDecode($errorMessage);
     $errhtml = "<a href='#' id='errorClick'>Show/Hide errors and warnings</a>";
     $errhtml .= "<div id='errorRow' colspan='3' >";  // style='display:none'
     
     if($errInfo == null)
     {
        $errhtml .= "Couldn't read results from the Umple compiler!<br><pre>".$errorMessage."</pre>";
     }
     else
     {
        $results = $errInfo["results"];
        
        
        foreach($results as $result)
        {
            $url = $result["url"];
            $line = intval($result["line"]) - $offset; 
            $errorCode = $result["errorCode"];
            $severityInt = intval($result["severity"]);
            if($severityInt > 2) {
              $severity = "Warning";
              $textcolor = "<font color=\"black\">";
            }
            else
            {
              $severity = "Error";
              $textcolor = "<font color=\"red\">";
            }
            $msg = htmlspecialchars($result["message"]);
                        
            $errhtml .= $textcolor." {$severity} on <a href=\"javascript:Action.setCaretPosition({$line});Action.updateLineNumberDisplay();\">line {$line}</a> : {$msg}.</font> <i><a href=\"{$url}\" target=\"helppage\">More information ({$errorCode})</a></i></br>";
        }
     }
    
     $errhtml .= "</div>";
        
     $errhtml .= "<script type=\"text/javascript\">jQuery(\"#errorClick\").click(function(a){a.preventDefault();jQuery(\"#errorRow\").toggle();});</script>";
     return $errhtml;
  }
  return "";
}

// taken from http://php.net/manual/en/function.json-decode.php
function jsonDecode ($json) 
{ 
      $json = str_replace(array("\\\\", "\\\""), array("&#92;", "&#34;"), $json); 
      $parts = preg_split("@(\"[^\"]*\")|([\[\]\{\},:])|\s@is", $json, -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE); 
      foreach ($parts as $index => $part) 
      { 
          if (strlen($part) == 1) 
          { 
              switch ($part) 
              { 
                  case "[": 
                  case "{": 
                      $parts[$index] = "array("; 
                      break; 
                  case "]": 
                  case "}": 
                      $parts[$index] = ")"; 
                      break; 
                  case ":": 
                    $parts[$index] = "=>"; 
                    break;    
                  case ",": 
                    break; 
                  default: 
                      return null; 
              } 
          } 
          else 
          { 
              if ((substr($part, 0, 1) != "\"") || (substr($part, -1, 1) != "\"")) 
              { 
                  return null; 
              } 
          } 
      } 
      $json = str_replace(array("&#92;", "&#34;", "$"), array("\\\\", "\\\"", "\\$"), implode("", $parts)); 
      return eval("return $json;"); 
} 
?>