├── .gitignore ├── preview.png ├── CypressGitElephantBundle.php ├── Resources ├── config │ ├── collector.xml │ └── services.xml └── views │ └── Collector │ └── toolbar.html.twig ├── composer.json ├── DependencyInjection ├── CypressGitElephantExtension.php └── Configuration.php ├── Collector └── GitElephantDataCollector.php ├── Util └── RepositoryUtilities.php ├── Collection └── GitElephantRepositoryCollection.php ├── Command ├── TagCommand.php ├── CommitCommand.php ├── MergeCommand.php └── HitCommand.php ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /vendor/ 2 | -------------------------------------------------------------------------------- /preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matteosister/GitElephantBundle/HEAD/preview.png -------------------------------------------------------------------------------- /CypressGitElephantBundle.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 6 | 7 | 8 | 9 | %cypress_git_elephant.profiler_repository_path% 10 | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cypresslab/gitelephant-bundle", 3 | "type": "symfony-bundle", 4 | "description": "GitElephant bundle for Symfony2", 5 | "keywords": [ 6 | "git" 7 | ], 8 | "homepage": "https://github.com/matteosister/GitElephant", 9 | "license": "LGPL-3.0+", 10 | "authors": [ 11 | { 12 | "name": "Matteo Giachino", 13 | "email": "matteog@gmail.com" 14 | } 15 | ], 16 | "require": { 17 | "php": ">=7.2.0", 18 | "symfony/config": "^4.0|^5.0", 19 | "symfony/console": "^4.0|^5.0", 20 | "symfony/dependency-injection": "^4.0|^5.0", 21 | "symfony/framework-bundle": "^4.0|^5.0", 22 | "symfony/http-foundation": "^4.0|^5.0", 23 | "symfony/http-kernel": "^4.0|^5.0", 24 | "cypresslab/gitelephant": "^4.0" 25 | }, 26 | "autoload": { 27 | "psr-0": { 28 | "Cypress\\GitElephantBundle": "" 29 | } 30 | }, 31 | "target-dir": "Cypress/GitElephantBundle" 32 | } 33 | -------------------------------------------------------------------------------- /DependencyInjection/CypressGitElephantExtension.php: -------------------------------------------------------------------------------- 1 | processConfiguration($configuration, $configs); 24 | 25 | $container->setParameter('cypress_git_elephant.repositories', $config['repositories']); 26 | $container->setParameter('cypress_git_elephant.binary_path', $config['binary_path']); 27 | $container->setParameter('cypress_git_elephant.profiler_repository_path', $config['profiler_repository_path']); 28 | 29 | $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); 30 | $loader->load('services.xml'); 31 | if ($config['enable_profiler']) { 32 | $loader->load('collector.xml'); 33 | } 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /DependencyInjection/Configuration.php: -------------------------------------------------------------------------------- 1 | getRootNode(); 22 | 23 | $rootNode 24 | ->children() 25 | ->scalarNode('binary_path') 26 | ->defaultValue('/usr/bin/git') 27 | ->end() 28 | ->booleanNode('enable_profiler') 29 | ->defaultValue(false) 30 | ->end() 31 | ->scalarNode('profiler_repository_path') 32 | ->defaultValue(false) 33 | ->end() 34 | ->arrayNode('repositories') 35 | ->requiresAtLeastOneElement() 36 | ->useAttributeAsKey('name') 37 | ->prototype('variable')->end() 38 | ->end() 39 | ->end() 40 | ->end() 41 | ; 42 | 43 | return $treeBuilder; 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /Resources/config/services.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 6 | 7 | 8 | GitElephant\GitBinary 9 | GitElephant\Repository 10 | Cypress\GitElephantBundle\Collection\GitElephantRepositoryCollection 11 | Cypress\GitElephantBundle\Util\RepositoryUtilities 12 | 13 | 14 | 15 | 17 | %cypress_git_elephant.repositories% 18 | %cypress_git_elephant.binary_path% 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /Collector/GitElephantDataCollector.php: -------------------------------------------------------------------------------- 1 | 16 | */ 17 | class GitElephantDataCollector extends DataCollector 18 | { 19 | private $repository; 20 | private $enabled; 21 | 22 | /** 23 | * Constructor 24 | * 25 | * @param $path 26 | */ 27 | public function __construct($path) 28 | { 29 | if ($path == false) { 30 | $this->enabled = false; 31 | } else { 32 | $this->enabled = true; 33 | $this->repository = new Repository($path); 34 | } 35 | } 36 | 37 | /** 38 | * Collect 39 | * 40 | * @param Request $request 41 | * @param Response $response 42 | * @param \Exception $exception 43 | */ 44 | public function collect(Request $request, Response $response, \Exception $exception = null) 45 | { 46 | $this->data = array( 47 | 'repository' => $this->repository !== null ? $this->repository : null, 48 | 'enabled' => $this->enabled 49 | ); 50 | } 51 | 52 | /** 53 | * Get repository 54 | * 55 | * @return mixed 56 | */ 57 | public function getRepository() 58 | { 59 | return $this->data['repository']; 60 | } 61 | 62 | /** 63 | * Get enabled 64 | * 65 | * @return mixed 66 | */ 67 | public function getEnabled() 68 | { 69 | return $this->data['enabled']; 70 | } 71 | 72 | /** 73 | * Get name 74 | * 75 | * @return string 76 | */ 77 | public function getName() 78 | { 79 | return 'git_elephant'; 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /Util/RepositoryUtilities.php: -------------------------------------------------------------------------------- 1 | repository = $repository; 23 | } 24 | 25 | public function setReference($reference) 26 | { 27 | if (strpos($reference, '/') === false) { 28 | $this->ref = $reference; 29 | $this->path = ''; 30 | return; 31 | } 32 | 33 | if ($this->repository->getBranch($reference) !== null) { 34 | $this->ref = $reference; 35 | $this->path = ''; 36 | return; 37 | } 38 | 39 | if ($this->repository->getTag($reference) !== null) { 40 | $this->ref = $reference; 41 | $this->path = ''; 42 | return; 43 | } 44 | 45 | $slices = explode('/', $reference); 46 | $test = ''; 47 | for ($i = 0; $i < count($slices); $i++) { 48 | $test .= $slices[$i]; 49 | $branch = $this->repository->getBranch($test); 50 | $tag = $this->repository->getTag($test); 51 | $test .= '/'; 52 | if ($branch !== null) { 53 | $this->ref = $branch->getName(); 54 | $this->path = ltrim(str_replace($branch->getName(), '', $reference), '/'); 55 | break; 56 | } 57 | if ($tag !== null) { 58 | $this->ref = $tag->getName(); 59 | $this->path = ltrim(str_replace($tag->getName(), '', $reference), '/'); 60 | break; 61 | } 62 | } 63 | } 64 | 65 | public function getRef() 66 | { 67 | return $this->ref; 68 | } 69 | 70 | public function getPath() 71 | { 72 | return $this->path; 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /Resources/views/Collector/toolbar.html.twig: -------------------------------------------------------------------------------- 1 | {% extends 'WebProfilerBundle:Profiler:layout.html.twig' %} 2 | 3 | {% block toolbar %} 4 | {% set branch = collector.repository.mainBranch %} 5 | {% if collector.enabled %} 6 | {% set icon %} 7 | 9 | 16 | 17 | {{ branch.name }} 18 | {% endset %} 19 | {% include 'WebProfilerBundle:Profiler:toolbar_item.html.twig' with { 'link': true } %} 20 | {% endif %} 21 | {% endblock %} 22 | 23 | {% block menu %} 24 | 25 | 26 | 28 | 35 | 36 | 37 | git 38 | 39 | {% endblock %} 40 | 41 | {% block panel %} 42 | {% set repo = collector.repository %} 43 | {% set number = 10 %} 44 |

Last {{ number }} Commits for {{ repo.mainBranch.name }} branch

45 | 53 | {% endblock %} 54 | -------------------------------------------------------------------------------- /Collection/GitElephantRepositoryCollection.php: -------------------------------------------------------------------------------- 1 | 13 | */ 14 | class GitElephantRepositoryCollection implements \ArrayAccess, \Iterator, \Countable 15 | { 16 | /** 17 | * the cursor position 18 | * 19 | * @var int 20 | */ 21 | private $position; 22 | 23 | /** 24 | * @var array 25 | */ 26 | private $repositories; 27 | 28 | /** 29 | * Class constructor 30 | * Accept an array of repository in format: 31 | * array( 32 | * string $name => Repository $class 33 | * ) 34 | * 35 | * @param array $repositories an array of repository classes 36 | * @param null $binary 37 | */ 38 | public function __construct($repositories, $binary = null) 39 | { 40 | $this->position = 0; 41 | 42 | foreach ($repositories as $name => $path) { 43 | $repository = new Repository($path, $binary); 44 | $repository->setName($name); 45 | $this->repositories[] = $repository; 46 | } 47 | } 48 | 49 | /** 50 | * Retrieve a repository by its name 51 | * 52 | * @param string $name the repository name 53 | * 54 | * @return Repository $repository 55 | */ 56 | public function get($name) 57 | { 58 | /** @var Repository $repository */ 59 | foreach ($this->repositories as $repository) { 60 | if ($repository->getName() == $name) { 61 | return $repository; 62 | } 63 | } 64 | 65 | return null; 66 | } 67 | 68 | /** 69 | * ArrayAccess interface 70 | * 71 | * @param int $offset offset 72 | * 73 | * @return bool 74 | */ 75 | public function offsetExists($offset) 76 | { 77 | return isset($this->repositories[$offset]); 78 | } 79 | 80 | /** 81 | * ArrayAccess interface 82 | * 83 | * @param int $offset offset 84 | * 85 | * @return null|mixed 86 | */ 87 | public function offsetGet($offset) 88 | { 89 | return isset($this->repositories[$offset]) ? $this->repositories[$offset] : null; 90 | } 91 | 92 | /** 93 | * ArrayAccess interface 94 | * 95 | * @param int $offset offset 96 | * @param mixed $value value 97 | */ 98 | public function offsetSet($offset, $value) 99 | { 100 | if (is_null($offset)) { 101 | $this->repositories[] = $value; 102 | } else { 103 | $this->repositories[$offset] = $value; 104 | } 105 | } 106 | 107 | /** 108 | * ArrayAccess interface 109 | * 110 | * @param int $offset offset 111 | */ 112 | public function offsetUnset($offset) 113 | { 114 | unset($this->repositories[$offset]); 115 | } 116 | 117 | /** 118 | * Countable interface 119 | * 120 | * @return int|void 121 | */ 122 | public function count() 123 | { 124 | return count($this->repositories); 125 | } 126 | 127 | /** 128 | * Iterator interface 129 | * 130 | * @return mixed 131 | */ 132 | public function current() 133 | { 134 | return $this->repositories[$this->position]; 135 | } 136 | 137 | /** 138 | * Iterator interface 139 | */ 140 | public function next() 141 | { 142 | ++$this->position; 143 | } 144 | 145 | /** 146 | * Iterator interface 147 | * 148 | * @return int 149 | */ 150 | public function key() 151 | { 152 | return $this->position; 153 | } 154 | 155 | /** 156 | * Iterator interface 157 | * 158 | * @return bool 159 | */ 160 | public function valid() 161 | { 162 | return isset($this->repositories[$this->position]); 163 | } 164 | 165 | /** 166 | * Iterator interface 167 | */ 168 | public function rewind() 169 | { 170 | $this->position = 0; 171 | } 172 | } 173 | -------------------------------------------------------------------------------- /Command/TagCommand.php: -------------------------------------------------------------------------------- 1 | 22 | */ 23 | class TagCommand extends Command 24 | { 25 | 26 | /** 27 | * The collection of repositories from which one will be commiting 28 | * 29 | * @var GitElephantRepositoryCollection 30 | */ 31 | private $repositories; 32 | 33 | public function __construct(GitElephantRepositoryCollection $c) 34 | { 35 | $this->repositories = $c; 36 | parent::__construct(); 37 | } 38 | 39 | /** 40 | * Tag command configuration 41 | */ 42 | protected function configure() 43 | { 44 | $this->setName('cypress:git:tag') 45 | ->setDefinition( 46 | array( 47 | new InputArgument( 48 | 'tag', 49 | InputArgument::REQUIRED, 50 | 'Tag title' 51 | ), 52 | new InputArgument( 53 | 'comment', 54 | InputArgument::OPTIONAL, 55 | 'Tag comment' 56 | ), 57 | ) 58 | ) 59 | ->setDescription('Tag current commit and push to all remotes') 60 | ->addOption( 61 | 'no-push', 62 | null, 63 | InputOption::VALUE_NONE, 64 | 'If set, the task won\'t push tag to remotes' 65 | ) 66 | ->addOption( 67 | 'all', 68 | null, 69 | InputOption::VALUE_NONE, 70 | 'If set, will tag to all repositories' 71 | ) 72 | ->setHelp( 73 | <<cypress:git:tag command will tag your current commit and push current branch to all remotes. Only apply fisrt repository, use --all option to apply all repositories. Use --no-push to commit only on your local repository. 75 | EOT 76 | ); 77 | } 78 | 79 | /** 80 | * Execute tag command 81 | * 82 | * @param InputInterface $input 83 | * @param OutputInterface $output 84 | * 85 | * @throws \Exception 86 | * @return int|null|void 87 | */ 88 | protected function execute(InputInterface $input, OutputInterface $output) 89 | { 90 | // Welcome 91 | $output->writeln( 92 | 'Welcome to the Cypress GitElephantBundle tag command.' 93 | ); 94 | if ($input->getOption('no-push')) { 95 | $output->writeln( 96 | '--no-push option enabled (this option disable push tag to remotes)' 97 | ); 98 | } 99 | 100 | /** @var GitElephantRepositoryCollection $rc */ 101 | $rc = $this->repositories; 102 | 103 | if ($rc->count() == 0) { 104 | throw new \Exception('Must have at least one Git repository. See https://github.com/matteosister/GitElephantBundle#how-to-use'); 105 | } 106 | 107 | /** @var Repository $repository */ 108 | foreach ($rc as $key => $repository) { 109 | if ($key == 0 || $key > 0 && $input->getOption('all')) { 110 | $repository->createTag($input->getArgument('tag'), null, $input->getArgument('comment') ? $input->getArgument('comment') : null); 111 | if (!$input->getOption('no-push')) { 112 | /** @var Remote $remote */ 113 | foreach ($repository->getRemotes() as $remote) { 114 | $repository->push($remote->getName(), $repository->getMainBranch()->getName()); // Push current branch to all remotes 115 | } 116 | } 117 | $output->writeln('Set tag ' . $input->getArgument('tag') . ' to local repository ' . $repository->getName() . (!$input->getOption('no-push') ? ' and pushed to all remotes.' : '')); 118 | } 119 | } 120 | } 121 | } 122 | -------------------------------------------------------------------------------- /Command/CommitCommand.php: -------------------------------------------------------------------------------- 1 | 22 | */ 23 | class CommitCommand extends Command 24 | { 25 | 26 | /** 27 | * The collection of repositories from which one will be commiting 28 | * 29 | * @var GitElephantRepositoryCollection 30 | */ 31 | private $repositories; 32 | 33 | public function __construct(GitElephantRepositoryCollection $c) 34 | { 35 | $this->repositories = $c; 36 | parent::__construct(); 37 | } 38 | 39 | /** 40 | * Commit command configuration 41 | */ 42 | protected function configure() 43 | { 44 | $this->setName('cypress:git:commit') 45 | ->setDefinition( 46 | array( 47 | new InputArgument( 48 | 'message', 49 | InputArgument::REQUIRED, 50 | 'Commit message' 51 | ), 52 | ) 53 | ) 54 | ->setDescription('Commit and push current branch to all remotes') 55 | ->addOption( 56 | 'no-push', 57 | null, 58 | InputOption::VALUE_NONE, 59 | 'If set, the task won\'t push commit to remotes' 60 | ) 61 | ->addOption( 62 | 'no-stage-all', 63 | null, 64 | InputOption::VALUE_NONE, 65 | 'If set, the task won\'t stage all the working tree content' 66 | ) 67 | ->addOption( 68 | 'all', 69 | null, 70 | InputOption::VALUE_NONE, 71 | 'If set, will commit and push to all repositories' 72 | ) 73 | ->setHelp( 74 | <<cypress:git:commit command will commit and push current branch to all remotes. Only apply fisrt repository, use --all option to apply all repositories. Use --no-push to commit only on your local repository without pushing. Use --no-stage-all to disable stage all the working tree content feature. 76 | EOT 77 | ); 78 | } 79 | 80 | /** 81 | * Execute commit command 82 | * 83 | * @param InputInterface $input 84 | * @param OutputInterface $output 85 | * 86 | * @throws \Exception 87 | * @return int|null|void 88 | */ 89 | protected function execute(InputInterface $input, OutputInterface $output) 90 | { 91 | // Welcome 92 | $output->writeln( 93 | 'Welcome to the Cypress GitElephantBundle commit command.' 94 | ); 95 | if ($input->getOption('no-push')) { 96 | $output->writeln( 97 | '--no-push option enabled (this option disable push commit to remotes)' 98 | ); 99 | } 100 | 101 | if ($this->repositories->count() == 0) { 102 | throw new \Exception('Must have at least one Git repository. See https://github.com/matteosister/GitElephantBundle#how-to-use'); 103 | } 104 | 105 | /** @var Repository $repository */ 106 | foreach ($this->repositories as $key => $repository) { 107 | if ($key == 0 || $key > 0 && $input->getOption('all')) { 108 | $repository->commit($input->getArgument('message'), !$input->getOption('no-stage-all')); 109 | if (!$input->getOption('no-push')) { 110 | /** @var Remote $remote */ 111 | foreach ($repository->getRemotes() as $remote) { 112 | $repository->push($remote->getName(), $repository->getMainBranch()->getName()); // Push last current branch commit to all remotes 113 | } 114 | } 115 | $output->writeln('New commit to local repository created ' . $repository->getName() . (!$input->getOption('no-push') ? ' and pushed to all remotes.' : '')); 116 | } 117 | } 118 | } 119 | } 120 | -------------------------------------------------------------------------------- /Command/MergeCommand.php: -------------------------------------------------------------------------------- 1 | 22 | */ 23 | class MergeCommand extends Command 24 | { 25 | /** 26 | * The collection of repositories from which one will be commiting 27 | * 28 | * @var GitElephantRepositoryCollection 29 | */ 30 | private $repositories; 31 | 32 | public function __construct(GitElephantRepositoryCollection $c) 33 | { 34 | $this->repositories = $c; 35 | parent::__construct(); 36 | } 37 | 38 | /** 39 | * Merge command configuration 40 | */ 41 | protected function configure() 42 | { 43 | $this->setName('cypress:git:merge') 44 | ->setDefinition( 45 | array( 46 | new InputArgument( 47 | 'source', 48 | InputArgument::OPTIONAL, 49 | 'Source branch', 50 | 'devel' // default source branch 51 | ), 52 | new InputArgument( 53 | 'destination', 54 | InputArgument::OPTIONAL, 55 | 'Destination branch', 56 | 'master' // default destination branch 57 | ), 58 | ) 59 | ) 60 | ->setDescription('Merge without fast forward from source to destination branch and push destination branch to all remotes') 61 | ->addOption( 62 | 'no-push', 63 | null, 64 | InputOption::VALUE_NONE, 65 | 'If set, the task won\'t push destination branch to remotes' 66 | ) 67 | ->addOption( 68 | 'fast-forward', 69 | null, 70 | InputOption::VALUE_NONE, 71 | 'If set, the task will use fast forward merge option' 72 | ) 73 | ->addOption( 74 | 'all', 75 | null, 76 | InputOption::VALUE_NONE, 77 | 'If set, will merge and push to all repositories' 78 | ) 79 | ->setHelp( 80 | <<cypress:git:merge command will merge without fast forward option from source to destination branch and push destination branch to all remotes. Only apply fisrt repository, use --all option to apply all repositories. Use --no-push to commit only on your local repository. Apply --fast-forward to disable no fast forward merge option. 82 | EOT 83 | ); 84 | } 85 | 86 | /** 87 | * Execute merge command 88 | * 89 | * @param InputInterface $input 90 | * @param OutputInterface $output 91 | * 92 | * @throws \Exception 93 | * @return int|null|void 94 | */ 95 | protected function execute(InputInterface $input, OutputInterface $output) 96 | { 97 | // Welcome 98 | $output->writeln( 99 | 'Welcome to the Cypress GitElephantBundle merge command.' 100 | ); 101 | if ($input->getOption('no-push')) { 102 | $output->writeln( 103 | '--no-push option enabled (this option disable push destination branch to remotes)' 104 | ); 105 | } 106 | 107 | /** @var GitElephantRepositoryCollection $rc */ 108 | $rc = $this->repositories; 109 | 110 | if ($rc->count() == 0) { 111 | throw new \Exception('Must have at least one Git repository. See https://github.com/matteosister/GitElephantBundle#how-to-use'); 112 | } 113 | 114 | /** @var Repository $repository */ 115 | foreach ($rc as $key => $repository) { 116 | if ($key == 0 || $key > 0 && $input->getOption('all')) { 117 | /** @var Branch $source */ 118 | $source = $repository->getBranch($input->getArgument('source')); 119 | if (is_null($source)) { 120 | throw new \Exception('Source branch ' . $input->getArgument('source') . ' doesn\'t exists'); 121 | } 122 | /** @var Branch $destination */ 123 | $destination = $repository->getBranch($input->getArgument('destination')); 124 | if (is_null($destination)) { 125 | throw new \Exception('Destination branch ' . $input->getArgument('destination') . ' doesn\'t exists'); 126 | } 127 | $repository->checkout($destination->getName()); 128 | $repository->merge($source, '', (!$input->getOption('fast-forward') ? 'no-ff' : 'ff-only')); 129 | if (!$input->getOption('no-push')) { 130 | /** @var Remote $remote */ 131 | foreach ($repository->getRemotes() as $remote) { 132 | $repository->push($remote->getName(), $repository->getMainBranch()->getName()); // Push destination branch to all remotes 133 | } 134 | } 135 | $repository->checkout($input->getArgument('source')); 136 | $output->writeln('Merge from ' . $input->getArgument('source') . ' branch to ' . $input->getArgument('destination') . ' done' . (!$input->getOption('no-push') ? ' and pushed to all remotes.' : '')); 137 | } 138 | } 139 | } 140 | } 141 | -------------------------------------------------------------------------------- /Command/HitCommand.php: -------------------------------------------------------------------------------- 1 | 22 | */ 23 | class HitCommand extends Command 24 | { 25 | 26 | /** 27 | * The collection of repositories from which one will be commiting 28 | * 29 | * @var GitElephantRepositoryCollection 30 | */ 31 | private $repositories; 32 | 33 | public function __construct(GitElephantRepositoryCollection $c) 34 | { 35 | $this->repositories = $c; 36 | parent::__construct(); 37 | } 38 | 39 | /** 40 | * Hit command configuration 41 | */ 42 | protected function configure() 43 | { 44 | $this->setName('cypress:git:hit') 45 | ->setDefinition( 46 | array( 47 | new InputArgument( 48 | 'tag', 49 | InputArgument::REQUIRED, 50 | 'Tag title' 51 | ), 52 | new InputArgument( 53 | 'comment', 54 | InputArgument::OPTIONAL, 55 | 'Tag comment' 56 | ), 57 | new InputArgument( 58 | 'source', 59 | InputArgument::OPTIONAL, 60 | 'Source branch', 61 | 'devel' // default source branch 62 | ), 63 | new InputArgument( 64 | 'destination', 65 | InputArgument::OPTIONAL, 66 | 'Destination branch', 67 | 'master' // default destination branch 68 | ), 69 | ) 70 | ) 71 | ->setDescription('Merge without fast forward from source to destination branch, tag destination branch and push to all remotes') 72 | ->addOption( 73 | 'no-push', 74 | null, 75 | InputOption::VALUE_NONE, 76 | 'If set, the task won\'t push to remotes' 77 | ) 78 | ->addOption( 79 | 'fast-forward', 80 | null, 81 | InputOption::VALUE_NONE, 82 | 'If set, the task will use fast forward merge option' 83 | ) 84 | ->addOption( 85 | 'all', 86 | null, 87 | InputOption::VALUE_NONE, 88 | 'If set, command will apply to all repositories' 89 | ) 90 | ->setHelp( 91 | <<cypress:git:hit combo command to merge without fast forward option from source to destination branch, tag destination branch and push to all remotes. Only apply fisrt repository, use --all option to apply all repositories. Use --no-push to commit only on your local repository. Apply --fast-forward to disable no fast forward merge option. 93 | EOT 94 | ); 95 | } 96 | 97 | /** 98 | * Execute hit command 99 | * 100 | * @param InputInterface $input 101 | * @param OutputInterface $output 102 | * 103 | * @throws \Exception 104 | * @return int|null|void 105 | */ 106 | protected function execute(InputInterface $input, OutputInterface $output) 107 | { 108 | // Welcome 109 | $output->writeln( 110 | 'Welcome to the Cypress GitElephantBundle hit command.' 111 | ); 112 | if ($input->getOption('no-push')) { 113 | $output->writeln( 114 | '--no-push option enabled (this option disable push to remotes)' 115 | ); 116 | } 117 | 118 | /** @var GitElephantRepositoryCollection $rc */ 119 | $rc = $this->repositories; 120 | 121 | if ($rc->count() == 0) { 122 | throw new \Exception('Must have at least one Git repository. See https://github.com/matteosister/GitElephantBundle#how-to-use'); 123 | } 124 | 125 | // Merge 126 | $command = $this->getApplication()->find('cypress:git:merge'); 127 | $arguments = array( 128 | 'command' => 'cypress:git:merge', 129 | 'source' => $input->getArgument('source'), 130 | 'destination' => $input->getArgument('destination'), 131 | '--no-push' => $input->getOption('no-push'), 132 | '--fast-forward' => $input->getOption('fast-forward'), 133 | '--all' => $input->getOption('all'), 134 | ); 135 | $inputMergeCommand = new ArrayInput($arguments); 136 | $returnCode = $command->run($inputMergeCommand, $output); 137 | if ($returnCode != 0) { 138 | $output->writeln('··· return code: ' . $returnCode); 139 | } 140 | 141 | // Tag 142 | $command = $this->getApplication()->find('cypress:git:tag'); 143 | $arguments = array( 144 | 'command' => 'cypress:git:tag', 145 | 'tag' => $input->getArgument('tag'), 146 | 'comment' => $input->getArgument('comment'), 147 | '--no-push' => $input->getOption('no-push'), 148 | '--all' => $input->getOption('all'), 149 | ); 150 | $inputTagCommand = new ArrayInput($arguments); 151 | // tag must apply to destination branch 152 | /** @var Repository $repository */ 153 | foreach ($rc as $key => $repository) { 154 | if ($key == 0) { 155 | /** @var Branch $destination */ 156 | $destination = $repository->getBranch($input->getArgument('destination')); 157 | $repository->checkout($destination->getName()); 158 | } 159 | } 160 | $returnCode = $command->run($inputTagCommand, $output); 161 | if ($returnCode != 0) { 162 | $output->writeln('··· return code: ' . $returnCode); 163 | } 164 | // change to source branch 165 | /** @var Repository $repository */ 166 | foreach ($rc as $key => $repository) { 167 | if ($key == 0) { 168 | /** @var Branch $destination */ 169 | $destination = $repository->getBranch($input->getArgument('source')); 170 | $repository->checkout($destination->getName()); 171 | } 172 | } 173 | } 174 | } 175 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GitElephantBundle # 2 | 3 | This is a simple bundle to use the [GitElephant library](https://github.com/matteosister/GitElephant) in a Symfony project. 4 | 5 | How to install 6 | -------------- 7 | 8 | **Method 1 - composer for Symfony 2.1 and above (recommended)** 9 | 10 | - Add the following line to the `composer.json` file: 11 | 12 | ``` json 13 | { 14 | "require": { 15 | "cypresslab/gitelephant-bundle": "dev-master" 16 | } 17 | } 18 | ``` 19 | 20 | - Execute composer update command 21 | 22 | ``` bash 23 | $ composer update 24 | ``` 25 | 26 | - Register the bundle in the kernel file 27 | 28 | *app/AppKernel.php* 29 | 30 | ``` php 31 | class AppKernel extends Kernel 32 | { 33 | public function registerBundles() 34 | { 35 | $bundles = array( 36 | // ...other bundles 37 | new Cypress\GitElephantBundle\CypressGitElephantBundle(), 38 | ); 39 | // ...other bundles 40 | return $bundles; 41 | } 42 | } 43 | ``` 44 | 45 | >Is recommended to register this bundle only in development environment for safety reasons. 46 | 47 | ``` php 48 | class AppKernel extends Kernel 49 | { 50 | public function registerBundles() 51 | { 52 | $bundles = array( 53 | // ...other bundles 54 | ); 55 | 56 | if (in_array($this->getEnvironment(), array('dev', 'test'))) { 57 | // ...other development and testing bundles 58 | $bundles[] = new Cypress\GitElephantBundle\CypressGitElephantBundle(); 59 | } 60 | 61 | return $bundles; 62 | } 63 | } 64 | ``` 65 | 66 | **Method 2 - submodules** 67 | 68 | You can also manage the two git repositories with git and submodules. It could be a mess if you don't know what you do, but I personally prefer this way 69 | 70 | ``` bash 71 | $ git submodule add git://github.com/matteosister/GitElephant.git src/git-elephant 72 | $ git submodule add git://github.com/matteosister/GitElephantBundle.git src/Cypress/GitElephantBundle 73 | ``` 74 | 75 | This two commands will clone the two repositories inside your "src" folder. You can use any folder you want in your symfony project. Just remember to update the *app/autoload.php* file and to activate the bundle in *app/AppKernel.php* 76 | 77 | The namespace for the bundle is "Cypress". You must clone the bundle in a Cypress folder, or it will not work. Your autoload file should point to the folder that **contains** the Cypress folder 78 | 79 | The GitElephant namespace in autoload should point to the "src" folder inside the GitElephant repository 80 | 81 | To actually clone the submodules give the command 82 | 83 | ``` bash 84 | $ git submodule update --init 85 | ``` 86 | 87 | For more info about git submodules read the [dedicated section](http://progit.org/book/ch6-6.html) inside the awesome **Pro Git** book by Scott Chacon. 88 | 89 | How to use 90 | ---------- 91 | 92 | To use the bundle you have to define two parameters in you *app/config/config.yml* file under *cypress_git_elephant* section 93 | 94 | cypress_git_elephant: 95 | binary_path: /usr/local/bin/git 96 | repositories: 97 | "GitElephant": "/home/matteo/libraries/GitElephant" 98 | "Bootstrap": "/home/matteo/libraries/Bootstrap" 99 | # ... other repositories 100 | 101 | **binary_path**: (optional) is the path to your git executable. If you don't provide this GItElephant try to argue the right executable with "which git". Remember that this lib only works on *nix filesystems. 102 | 103 | Now, inside your controllers, you can easily access the GitElephant library with dependency injection: 104 | 105 | **repositories**: (at least one is required) is an hash with *key*: a repository name, *value*: the repository path 106 | 107 | The repository path could also be a bare repository (useful for web servers). But without a checked out copy you won't be able to modify the repository state. You will be able to show the repository, but not, for example, create a new commit 108 | 109 | ``` php 110 | class AwesomeController extends Controller 111 | { 112 | /** 113 | * @Route("/", name="repository_root") 114 | * @Template() 115 | * 116 | * @param \Symfony\Component\HttpFoundation\Request $request 117 | * @return array 118 | */ 119 | public function rootAction(Request $request) 120 | { 121 | // Repository instance 122 | $repositories = $this->get('cypress_git_elephant.repository_collection'); 123 | // There is also an handy alias 124 | $repositories = $this->get('git_repositories'); 125 | // $repositories is an instance of GitElephant\Cypress\GitElephantBundle\Collection\GitElephantRepositoryCollection 126 | // it has the Countable, ArrayAccess and Iterator interfaces. So you can do: 127 | $num_repos = count($repositories); //number of repositories 128 | $git_elephant = $repositories->get('GitElephant'); // retrieve a Repository instance by its name (defined in config.yml) 129 | // iterate 130 | foreach ($repositories as $repo) { 131 | $repo->getLog(); 132 | } 133 | } 134 | } 135 | ``` 136 | 137 | Read the documentation of [GitElephant](https://github.com/matteosister/GitElephant) to know what you can do with the *Repository* class, or [watch the demo site](http://gitelephant.cypresslab.net/) build with this bundle, and [the relative code](https://github.com/matteosister/GitElephantDemoBundle). 138 | 139 | Web Debug Toolbar 140 | ------------------ 141 | 142 | As a bonus, thanks to the GitElephant library, you can have the branch of any repository right inside yuor Symfony2 toolbar. 143 | 144 | Add this to your **dev** configuration file *app/config/config_dev.yml* 145 | 146 | cypress_git_elephant: 147 | enable_profiler: true 148 | profiler_repository_path: "%kernel.root_dir%/../" 149 | 150 | If you use git with Symfony2, with the above configuration, you can see directly from the browser the branch you are in. Click on the icon and you get a list of the last 10 commits for the branch you are in. 151 | 152 | Available console commands 153 | -------------------------- 154 | 155 | **cypress:git:commit** 156 | 157 | This command is useful to commit (default stage all) all changes in current branch and push to all remotes. 158 | 159 | ``` bash 160 | $ php app/console cypress:git:commit [--no-push] [--no-stage-all] [--all] message 161 | ``` 162 | 163 | **cypress:git:tag** 164 | 165 | This command is useful to tag current commit and push to all remotes. 166 | 167 | ``` bash 168 | $ php app/console cypress:git:tag [--no-push] [--all] tag [comment] 169 | ``` 170 | 171 | **cypress:git:merge** 172 | 173 | This command will merge (default without fast forward) from source (default devel) to destination (default master) branch and push to all remotes. 174 | 175 | ``` bash 176 | $ php app/console cypress:git:merge [--no-push] [--fast-forward] [--all] [source] [destination] 177 | ``` 178 | 179 | **cypress:git:hit** 180 | 181 | Combo command to merge without fast forward option from source to destination branch, tag destination branch and push to all remotes. 182 | 183 | ``` bash 184 | $ php app/console cypress:git:hit [--no-push] [--fast-forward] [--all] tag [comment] [source] [destination] 185 | ``` 186 | 187 | Example 188 | ------- 189 | 190 | There is also a [demo bundle](https://github.com/matteosister/GitElephantDemoBundle) to see it in action. 191 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | --------------------------------------------------------------------------------