TracyComponent/src/FuzeWorks/GitTracyBridge.php

261 lines
8.1 KiB
PHP

<?php
/**
* FuzeWorks Tracy Component.
*
* The FuzeWorks PHP FrameWork
*
* Copyright (C) 2013-2019 TechFuze
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* @author TechFuze
* @copyright Copyright (c) 2013 - 2019, TechFuze. (http://techfuze.net)
* @license https://opensource.org/licenses/MIT MIT License
*
* @link http://techfuze.net/fuzeworks
* @since Version 1.2.0
*
* @version Version 1.2.0
*/
namespace FuzeWorks;
use Tracy\IBarPanel;
use Tracy\Debugger;
/**
* GitTracyBridge Class.
*
* This class provides adds a panel to the Tracy Bar showing the current git branch
*
* This class registers in Tracy, and creates a Bar object which contains the Git version.
* @author Copyright (c) 2015 Jakub Vyvážil
* @codeCoverageIgnore
*/
class GitTracyBridge implements IBarPanel
{
/**
* Register the bar
*/
public static function register()
{
$class = new self();
$bar = Debugger::getBar();
$bar->addPanel($class);
}
/**
* Renders HTML code for custom tab.
*
* @return string
*/
public function getTab(): string
{
$style = '';
if ($this->getBranchName() === 'master' || $this->getBranchName() === 'staging') {
$style = 'background:#dd4742;color:white;padding:3px 4px 4px';
}
$icon = '<svg viewBox="10 10 512 512"><path fill="#f03c2e" d="M 502.34111,278.80364 278.79809,502.34216 c -12.86794,12.87712 -33.74784,12.87712 -46.63305,0 l -46.4152,-46.42448 58.88028,-58.88364 c 13.68647,4.62092 29.3794,1.51948 40.28378,-9.38732 10.97012,-10.9748 14.04307,-26.80288 9.30465,-40.537 l 56.75401,-56.74844 c 13.73383,4.73404 29.56829,1.67384 40.53842,-9.31156 15.32297,-15.3188 15.32297,-40.15196 0,-55.48356 -15.3341,-15.3322 -40.16175,-15.3322 -55.50254,0 -11.52454,11.53592 -14.37572,28.47172 -8.53182,42.6722 l -52.93386,52.93048 0,-139.28512 c 3.73267,-1.84996 7.25863,-4.31392 10.37114,-7.41756 15.32295,-15.3216 15.32295,-40.15196 0,-55.49696 -15.32296,-15.3166 -40.16844,-15.3166 -55.48025,0 -15.32296,15.345 -15.32296,40.17536 0,55.49696 3.78727,3.78288 8.17299,6.64472 12.85234,8.5604 l 0,140.57336 c -4.67935,1.91568 -9.05448,4.75356 -12.85234,8.56264 -11.60533,11.60168 -14.39801,28.6378 -8.4449,42.89232 L 162.93981,433.11336 9.6557406,279.83948 c -12.8743209,-12.88768 -12.8743209,-33.768 0,-46.64456 L 233.20978,9.65592 c 12.87017,-12.87456 33.74338,-12.87456 46.63305,0 l 222.49828,222.50316 c 12.87852,12.87876 12.87852,33.76968 0,46.64456"/></svg>';
$label = '<span class="tracy-label" style="'.$style.'">'.$this->getBranchName().'</span>';
return $icon.$label;
}
/**
* Renders HTML code for custom panel.
*
* @return string
*/
public function getPanel(): string
{
if ($this->isUnderVersionControl()) {
$title = '<h1>GIT</h1>';
$warning = '';
$cntTable = '';
if ($this->getBranchName() === 'master' || $this->getBranchName() === 'staging') {
$warning = '<p style="color: #dd4742; font-weight: 700;">You are working in '.$this->getBranchName().' branch</p>';
}
// commit message
if ($this->getLastCommitMessage() !== null) {
$cntTable .= '<tr><td>Last commit</td><td> '.$this->getLastCommitMessage().' </td></tr>';
}
// heads
if ($this->getHeads() !== null) {
$cntTable .= '<tr><td>Branches</td><td> '.$this->getHeads().' </td></tr>';
}
// remotes
if ($this->getRemotes() !== null) {
$cntTable .= '<tr><td>Remotes</td><td> '.$this->getRemotes().' </td></tr>';
}
// tags
if ($this->getTags() !== null && !empty($this->getTags())) {
$cntTable .= '<tr><td>Tags</td><td> '.$this->getTags().' </td></tr>';
}
$content = '<div class=\"tracy-inner tracy-InfoPanel\"><table><tbody>'.
$cntTable.
'</tbody></table></div>';
return $title.$warning.$content;
}
return "";
}
protected function getBranchName(): string
{
$dir = $this->getDirectory();
$head = $dir.'/.git/HEAD';
if ($dir && is_readable($head)) {
$branch = file_get_contents($head);
if (strpos($branch, 'ref:') === 0) {
$parts = explode('/', $branch);
return substr($parts[2], 0, -1);
}
return '('.substr($branch, 0, 7).'&hellip;)';
}
return 'not versioned';
}
protected function getLastCommitMessage()
{
$dir = $this->getDirectory();
$fileMessage = $dir.'/.git/COMMIT_EDITMSG';
if ($dir && is_readable($fileMessage)) {
$message = file_get_contents($fileMessage);
return $message;
}
return null;
}
protected function getHeads()
{
$dir = $this->getDirectory();
$files = scandir($dir.'/.git/refs/heads');
$message = '';
if ($dir && is_array($files)) {
foreach ($files as $file) {
if ($file !== '.' && $file !== '..') {
if ($file === $this->getBranchName()) {
$message .= '<strong>'.$file.' </strong>';
} else {
$message .= $file.' <br>';
}
}
}
return $message;
}
return null;
}
protected function getRemotes()
{
$dir = $this->getDirectory();
try {
$files = scandir($dir.'/.git/refs/remotes');
} catch (\ErrorException $e) {
return null;
}
$message = '';
if ($dir && is_array($files)) {
foreach ($files as $file) {
if ($file !== '.' && $file !== '..') {
$message .= $file.' ';
}
}
return $message;
}
return null;
}
protected function getTags()
{
$dir = $this->getDirectory();
$files = scandir($dir.'/.git/refs/tags');
$message = '';
if ($dir && is_array($files)) {
foreach ($files as $file) {
if ($file !== '.' && $file !== '..') {
$message .= $file.' ';
}
}
return $message;
}
return null;
}
private function getDirectory(): string
{
$scriptPath = $_SERVER['SCRIPT_FILENAME'];
$dir = realpath(dirname($scriptPath));
while ($dir !== false && !is_dir($dir.'/.git')) {
flush();
$currentDir = $dir;
$dir .= '/..';
$dir = realpath($dir);
// Stop recursion to parent on root directory
if ($dir === $currentDir) {
break;
}
}
return $dir;
}
private function isUnderVersionControl(): bool
{
$dir = $this->getDirectory();
$head = $dir.'/.git/HEAD';
if ($dir && is_readable($head)) {
return true;
}
return false;
}
}