remote forking: use the original http/https url in description
[phorkie.git] / src / phorkie / Repository.php
index fef565655c295a3deda9f2f7d706d66ddfe5334a..25b049cb1d91a4280ec1def1f770717907612ed6 100644 (file)
@@ -12,11 +12,33 @@ class Repository
     public $id;
 
     /**
-     * Full path to the git repository
+     * Full path to the .git repository
      *
      * @var string
      */
-    public $repoDir;
+    public $gitDir;
+
+    /**
+     * Full path to the work tree directory
+     *
+     * @var string
+     */
+    public $workDir;
+
+    /**
+     * Revision of the repository that shall be shown
+     *
+     * @var string
+     */
+    public $hash;
+
+    /**
+     * Commit message of the last (or current) revision
+     *
+     * @var string
+     */
+    public $message;
+
 
     /**
      * Load Repository data from GET-Request
@@ -33,13 +55,75 @@ class Repository
         if (!is_numeric($_GET['id'])) {
             throw new Exception_Input('Paste ID not numeric');
         }
+        if (isset($_GET['rev'])) {
+            $this->hash = $_GET['rev'];
+        }
+
         $this->id = (int)$_GET['id'];
+        $this->loadDirs();
+        $this->loadHash();
+        $this->loadMessage();
+    }
+
+    protected function loadDirs()
+    {
+        $gitDir = $GLOBALS['phorkie']['cfg']['gitdir'] . '/' . $this->id . '.git';
+        if (!is_dir($gitDir)) {
+            throw new Exception_NotFound(
+                sprintf('Paste %d .git dir not found', $this->id)
+            );
+        }
+        $this->gitDir = $gitDir;
+
+        $workDir = $GLOBALS['phorkie']['cfg']['workdir'] . '/' . $this->id;
+        if (!is_dir($workDir)) {
+            throw new Exception_NotFound(
+                sprintf('Paste %d work dir not found', $this->id)
+            );
+        }
+        $this->workDir = $workDir;
+    }
 
-        $repoDir = $GLOBALS['phorkie']['cfg']['repos'] . '/' . $this->id;
-        if (!is_dir($repoDir)) {
-            throw new Exception_NotFound('Paste not found');
+    public function loadHash()
+    {
+        return;
+        if ($this->hash !== null) {
+            return;
+        }
+
+        $output = $this->getVc()->getCommand('log')
+            ->setOption('pretty', 'format:%H')
+            ->setOption('max-count', 1)
+            ->execute();
+        $output = trim($output);
+        if (strlen($output) !== 40) {
+            throw new Exception(
+                'Loading commit hash failed: ' . $output
+            );
+        }
+        $this->hash = $output;
+    }
+
+    /**
+     * Populates $this->message
+     *
+     * @return void
+     */
+    public function loadMessage()
+    {
+        $rev = (isset($this->hash)) ? $this->hash : 'HEAD';
+        $output = $this->getVc()->getCommand('log')
+            ->setOption('oneline')
+            ->addArgument('-1')
+            ->addArgument($rev)
+            ->execute();
+        $output = trim($output);
+        if (strpos($output, ' ') > 0) {
+            $output = substr($output, strpos($output, ' '), strlen($output));
+            $this->message = trim($output);
+        } else {
+            $this->message = "This commit message intentionally left blank.";
         }
-        $this->repoDir = $repoDir;
     }
 
     public function loadById($id)
@@ -48,17 +132,13 @@ class Repository
             throw new Exception_Input('Paste ID not numeric');
         }
         $this->id = (int)$id;
-
-        $repoDir = $GLOBALS['phorkie']['cfg']['repos'] . '/' . $this->id;
-        if (!is_dir($repoDir)) {
-            throw new Exception_NotFound('Paste not found');
-        }
-        $this->repoDir = $repoDir;
+        $this->loadDirs();
+        $this->loadHash();
     }
 
     public function getVc()
     {
-        return new \VersionControl_Git($this->repoDir);
+        return new \VersionControl_Git($this->gitDir);
     }
 
     /**
@@ -68,28 +148,43 @@ class Repository
      */
     public function getFiles()
     {
-        $files = glob($this->repoDir . '/*');
+        $files = $this->getFilePaths();
         $arFiles = array();
-        foreach ($files as $path) {
-            $arFiles[] = new File($path, $this);
+        foreach ($files as $name) {
+            $arFiles[] = new File($name, $this);
         }
         return $arFiles;
     }
 
-    public function getFileByName($name, $bHasToExist = true)
+    protected function getFilePaths()
     {
-        $base = basename($name);
-        if ($base != $name) {
-            throw new Exception('No directories supported for now');
+        if ($this->hash === null) {
+            $hash = 'HEAD';
+        } else {
+            $hash = $this->hash;
         }
+        $output = $this->getVc()->getCommand('ls-tree')
+            ->setOption('r')
+            ->setOption('name-only')
+            ->addArgument($hash)
+            ->execute();
+        return explode("\n", trim($output));
+    }
+
+    public function getFileByName($name, $bHasToExist = true)
+    {
+        $name = Tools::sanitizeFilename($name);
         if ($name == '') {
             throw new Exception_Input('Empty file name given');
         }
-        $path = $this->repoDir . '/' . $base;
-        if ($bHasToExist && !is_readable($path)) {
-            throw new Exception_Input('File does not exist');
+
+        if ($bHasToExist) {
+            $files = $this->getFilePaths();
+            if (array_search($name, $files) === false) {
+                throw new Exception_Input('File does not exist');
+            }
         }
-        return new File($path, $this);
+        return new File($name, $this);
     }
 
     public function hasFile($name)
@@ -110,20 +205,34 @@ class Repository
      */
     public function delete()
     {
-        return Tools::recursiveDelete($this->repoDir);
+        $db = new Database();
+        $db->getIndexer()->deleteRepo($this);
+
+        return Tools::recursiveDelete($this->workDir)
+            && Tools::recursiveDelete($this->gitDir);
+    }
+
+    public function getTitle()
+    {
+        $desc = $this->getDescription();
+        if (trim($desc) != '') {
+            return $desc;
+        }
+
+        return 'paste #' . $this->id;
     }
 
     public function getDescription()
     {
-        if (!is_readable($this->repoDir . '/.git/description')) {
+        if (!is_readable($this->gitDir . '/description')) {
             return null;
         }
-        return file_get_contents($this->repoDir . '/.git/description');
+        return file_get_contents($this->gitDir . '/description');
     }
 
     public function setDescription($description)
     {
-        file_put_contents($this->repoDir . '/.git/description', $description);
+        file_put_contents($this->gitDir . '/description', $description);
     }
 
     /**
@@ -131,12 +240,16 @@ class Repository
      *
      * @param string $type Link type. Supported are:
      *                     - "edit"
+     *                     - "delete"
+     *                     - "delete-confirm"
      *                     - "display"
      *                     - "fork"
+     *                     - "revision"
+     * @param string $option
      *
      * @return string
      */
-    public function getLink($type)
+    public function getLink($type, $option = null)
     {
         if ($type == 'edit') {
             return '/' . $this->id . '/edit';
@@ -144,14 +257,80 @@ class Repository
             return '/' . $this->id;
         } else if ($type == 'fork') {
             return '/' . $this->id . '/fork';
+        } else if ($type == 'doap') {
+            return '/' . $this->id . '/doap';
         } else if ($type == 'delete') {
             return '/' . $this->id . '/delete';
         } else if ($type == 'delete-confirm') {
             return '/' . $this->id . '/delete/confirm';
+        } else if ($type == 'revision') {
+            return '/' . $this->id . '/rev/' . $option;
         }
         throw new Exception('Unknown link type');
     }
 
+    public function getCloneURL($public = true)
+    {
+        $var = $public ? 'public' : 'private';
+        if (isset($GLOBALS['phorkie']['cfg']['git'][$var])) {
+            return $GLOBALS['phorkie']['cfg']['git'][$var] . $this->id . '.git';
+        }
+        return null;
+    }
+
+    /**
+     * Returns the history of the repository.
+     * We don't use VersionControl_Git's rev list fetcher since it does not
+     * give us separate email addresses and names, and it does not give us
+     * the amount of changed (added/deleted) lines.
+     *
+     * @return array Array of history objects
+     */
+    public function getHistory()
+    {
+        $output = $this->getVc()->getCommand('log')
+            ->setOption('pretty', 'format:commit %H%n%at%n%an%n%ae')
+            ->setOption('max-count', 10)
+            ->setOption('shortstat')
+            ->execute();
+
+        $arCommits = array();
+        $arOutput = explode("\n", $output);
+        $lines = count($arOutput);
+        $current = 0;
+        while ($current < $lines) {
+            $commit = new Repository_Commit();
+            list($name,$commit->hash) = explode(' ', $arOutput[$current]);
+            if ($name !== 'commit') {
+                throw new Exception(
+                    'Git log output format not as expected: ' . $arOutput[$current]
+                );
+            }
+            $commit->committerTime  = $arOutput[$current + 1];
+            $commit->committerName  = $arOutput[$current + 2];
+            $commit->committerEmail = $arOutput[$current + 3];
+
+            if (substr($arOutput[$current + 4], 0, 1) != ' ') {
+                //commit without changed lines
+                $arCommits[] = $commit;
+                $current += 4;
+                continue;
+            }
+
+            $arLineParts = explode(' ', trim($arOutput[$current + 4]));
+            $commit->filesChanged = $arLineParts[0];
+            $commit->linesAdded   = $arLineParts[3];
+            if (isset($arLineParts[5])) {
+                $commit->linesDeleted = $arLineParts[5];
+            }
+
+            $current += 6;
+
+            $arCommits[] = $commit;
+        }
+
+        return $arCommits;
+    }
 }
 
 ?>