diff --git a/.bowerrc b/.bowerrc deleted file mode 100644 index 7f6b222..0000000 --- a/.bowerrc +++ /dev/null @@ -1,3 +0,0 @@ -{ - "directory": "web/components/" -} diff --git a/.gitignore b/.gitignore index 28eb5fc..6d98c4e 100644 --- a/.gitignore +++ b/.gitignore @@ -2,12 +2,13 @@ /.mage/logs/*.log /composer.lock /vendor/ -/propel.yml +/propel.yaml /src/Gist/Model/Base/ /src/Gist/Model/Map/ -/web/components/ /app/propel/ +/node_modules/ /app/config/config.yml /app/config/propel/ /data/ /trans/ +/cache/ diff --git a/.mage/config/environment/.gitignore b/.mage/config/environment/.gitignore deleted file mode 100644 index e69de29..0000000 diff --git a/.mage/config/environment/prod.yml.dist b/.mage/config/environment/prod.yml.dist deleted file mode 100644 index a5bcb3b..0000000 --- a/.mage/config/environment/prod.yml.dist +++ /dev/null @@ -1,28 +0,0 @@ -# prod -# Rename this file to "prod.yml" -deployment: - user: gist - from: ./ - to: /var/www/gist/ - excludes: - - "*.svn" - - "*.git" - - "*.swp" - - "app/config/config.yml" - - "app/config/propel/" - - "app/propel/" - - "data/git" - - "deploy" - - "tags" - - "propel.yaml" - - "composer.lock" - - "composer.json" - - "bower.json" - - ".bowerrc" -hosts: - - gist.mycompany.com -tasks: - pre-deploy: - on-deploy: - post-deploy: -verbose_logging: true diff --git a/.mage/config/general.yml b/.mage/config/general.yml deleted file mode 100644 index cff23fa..0000000 --- a/.mage/config/general.yml +++ /dev/null @@ -1,7 +0,0 @@ -# global settings -name: Gist -email: -notifications: false -logging: true -maxlogs: 30 -ssh_needs_tty: false diff --git a/.mage/logs/.gitignore b/.mage/logs/.gitignore deleted file mode 100644 index c96a04f..0000000 --- a/.mage/logs/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -* -!.gitignore \ No newline at end of file diff --git a/.mage/tasks/.gitignore b/.mage/tasks/.gitignore deleted file mode 100644 index e69de29..0000000 diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..8d29688 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,26 @@ +## Environment + +* GIST version or GIT commit: ... +* PHP Version: ... +* GIT version. ... +* HTTPD (Nginx, Apache2): ... +* DBMS (MySQL, SQLite, PostgreSQL): ... + + +## Description + +... + +### Steps to reproduce + +1. ... +2. ... +3. ... + +#### Observed Results + +... + +#### Expected Results + +... diff --git a/Makefile b/Makefile index 599de5e..6b5a389 100644 --- a/Makefile +++ b/Makefile @@ -1,54 +1,58 @@ COMPOSER ?= composer -BOWER ?= bower +NPM ?= npm GIT ?= git MKDIR ?= mkdir PHP ?= php +RM ?= rm -all: update +all: update clean-cache composer: - @echo "Installing application's dependencies" - @echo "-------------------------------------" - @echo + @echo "Installing PHP dependencies" + @echo "---------------------------" + @echo - $(COMPOSER) install $(COMPOSER_INSTALL_FLAGS) -bower: - @echo "Installing application's dependencies" - @echo "-------------------------------------" - @echo + ${COMPOSER} install - $(BOWER) install +npm: + @echo "Installing CSS/JS dependencies" + @echo "------------------------------" + @echo -optimize: - @echo "Optimizing Composer's autoloader, can take some time" - @echo "----------------------------------------------------" - @echo - - $(COMPOSER) dump-autoload --optimize + ${NPM} install + ${NPM} update update: @echo "Updating application's dependencies" @echo "-----------------------------------" - @echo + @echo - sh -c 'test -d app && $(GIT) add app && $(GIT) commit -m "Configuration"' - $(GIT) pull origin master + ${GIT} pull origin master ${MKDIR} -p data/git - $(COMPOSER) update - $(BOWER) install + ${MKDIR} -p data/cache + ${COMPOSER} update + ${NPM} install + ${NPM} update + +clean-cache: + @echo "Removing cache" + @echo "--------------" + @echo + + ${RM} -fr cache/* run: @echo "Run development server" @echo "----------------------" - @echo + @echo - $(PHP) -S 127.0.0.1:8080 -t web + ${PHP} -S 127.0.0.1:8080 -t web propel: @echo "Propel migration" @echo "----------------" - @echo - + @echo + ./vendor/propel/propel/bin/propel config:convert ./vendor/propel/propel/bin/propel model:build --recursive ./vendor/propel/propel/bin/propel migration:diff --recursive diff --git a/README.md b/README.md index a9e1493..ccbff71 100644 --- a/README.md +++ b/README.md @@ -1,418 +1,23 @@ -Table of Contents -================= - - * [GIST](#gist) - * [Requirements](#requirements) - * [Git](#git) - * [Composer](#composer) - * [Bower](#bower) - * [Installation](#installation) - * [Upgrade](#upgrade) - * [Configuration](#configuration) - * [Makefile](#makefile) - * [API](#api) - * [Console](#console) - * [Deployment](#deployment) - * [Contributors](#contributors) - - GIST ==== GIST is an open-source application to share code. https://www.deblan.io/post/517/gist-est-dans-la-place -![Gist](https://upload.deblan.org/u/2015-11/565b93a5.png "Gist") +**[Read the wiki for more information](https://gitnet.fr/deblan/gist/wiki/_pages).** -![Gist](https://upload.deblan.org/u/2016-06/57655dec.png "Gist") +### Editor +![Gist](https://upload.deblan.org/u/2018-08/5b7ab7a6.png "Gist editor") -Requirements ------------- +### Result -* PHP >= 5.4 -* GIT -* MySQL, PostgreSQL or SQLite -* Composer (php) -* Bower (node) +![Gist](https://upload.deblan.org/u/2018-08/5b7ab7d4.png "Gist result") -### Git +### Account -Git can maybe be downloaded from your system's repositories. +![Gist](https://upload.deblan.org/u/2018-08/5b7aba2d.png "Gist account") - $ git config --global user.email "you@example.com" - $ git config --global user.name "Your Name" +### Embeded Gist -### Composer - -Composer can maybe be downloaded from your system's repositories. -Else, follow the next instructions: - - # With cURL - $ curl -sS https://getcomposer.org/installer | php - - # With Wget - $ wget -O - -q https://getcomposer.org/installer | php - - $ chmod +x composer.phar - - # For a local installation and if the envvar PATH contains "$HOME/bin/" - $ mv composer.phar ~/bin/composer - - # For a global installation - $ sudo mv composer.phar /usr/local/bin/composer - -### Bower - - $ sudo apt-get install npm - $ sudo npm install -g bower - -Installation ------------- - - $ cd /path/to/www/ - $ git clone https://gitnet.fr/deblan/gist - $ cd gist - $ make - $ cp propel-dist.yaml propel.yaml - -Edit `propel.yaml`. **Use spaces instead of tabulations**. - -**MySQL** - - propel: - database: - connections: - default: - adapter: mysql - # http://www.php.net/manual/en/ref.pdo-mysql.connection.php - dsn: "mysql:host=DATABASE_SERVER;dbname=DATABASE_NAME" - user: DATEBASE_USER - password: DATEBASE_PASSWORD - settings: - charset: utf8 - queries: - utf8: "SET NAMES utf8 COLLATE utf8_unicode_ci, COLLATION_CONNECTION = utf8_unicode_ci, COLLATION_DATABASE = utf8_unicode_ci, COLLATION_SERVER = utf8_unicode_ci" - - [...] - -**SQLITE** - - propel: - database: - connections: - default: - adapter: sqlite - # http://www.php.net/manual/en/ref.pdo-sqlite.connection.php - dsn: "sqlite:/PATH/TO/gist.sqlite" - user: ~ - password: ~ - - [...] - -Then `$ make propel`. - -**Versions >= 1.4.4 only**: `$ cp app/config/config.yml.dist app/config/config.yml` - -See the [configuration section](#configuration) for more information about configuration. - ---- - -The web server must have permission to write into `data`. - - $ sudo chown -R www-data:www-data data - -Your webserver must be configured to serve `web/` as document root. If you use nginx, all virtual paths must be rooted with `web/index.php` or `web/app_dev.php` ([documentation](https://www.nginx.com/resources/wiki/start/topics/recipes/symfony/)). If you use apache, you must enable the `rewrite` module and restart: - - $ sudo a2enmod rewrite - $ sudo service apache2 restart - -`app_dev.php` is the development router. Access is granted for an IP range defined in the same file. - -Upgrade -------- - -If your version is less than v1.4.2, run: `test -d app && git add app && git commit -m "Configuration"`. - - $ make update - $ make propel - -If you upgrade to v1.4.1 or more: `app/console migrate:to:v1.4.1`. - -If you upgrade to v1.4.4 or more, the configuration is moved to a `app/config/config.yml`: `$ cp app/config/config.yml.dist app/config/config.yml` and see the [configuration section](#configuration) for more information. - -If you upgrade to v1.7.0 or more, see the [configuration section](#configurationh) for more information about new options. - -Configuration -------------- - -### Version < 1.4.4 - -Edit `app/bootstrap.php.d/70-security.php`. - -* `$app['token']`: the securty token (a strong passphrase). -* `$app['enable_registration']`: defines if the registration is allowed (`true` or `false`) -* `$app['enable_login']`: defines if the login is allowed (`true` or `false`) -* `$app['login_required_to_edit_gist']`: defines if the user must be logged to create or clone a Gist (`true` or `false`) -* `$app['login_required_to_view_gist']`: defines if the user must be logged to view a Gist (`true` or `false`) -* `$app['login_required_to_view_gist']`: defines if the user must be logged to view an embeded Gist (`true` or `false`) - -If you install Gist on your server, you have to modify the `base_uri` of the API. -Edit `app/bootstrap.php.d/60-api.php` and replace `https://gist.deblan.org/`. - -### Version >= 1.4.4 - -Edit `app/config/config.yml`. - -* `security.token`: the securty token (a strong passphrase) -* `security.enable_registration`: defines if the registration is allowed (`true` or `false`) -* `security.enable_login`: defines if the login is allowed (`true` or `false`) -* `security.login_required_to_edit_gist`: defines if the user must be logged to create or clone a Gist (`true` or `false`) -* `security.login_required_to_view_gist`: defines if the user must be logged to view a Gist (`true` or `false`) -* `security.login_required_to_view_gist`: defines if the user must be logged to view an embeded Gist (`true` or `false`) -* `api.base_uri`: The url of your instance. -* `data.path`: the path where the files are saved. -* `git.path`: The path of `git`. -* `theme.name`: the name of the theme (`dark` or `light`) - -### Version >= v1.7.0 - -* `api.enabled`: defines if the API is enabled (`true` or `false`) -* `api.api_key_required`: defines if the API key is required to access the API (`true` or `false`) -* `api.client.api_key`: defines the client API key (`string`) - -Makefile --------- - -A Makefile is provided to automate some tasks. - -* `make` will install application's dependencies via Composer and Bower, -* `make optimize` will run Composer's autoloader dump script with classmap -* `make update` will update the application -* `make propel` will generate propel's files -* `make run` will run development server on http://127.0.0.1:8080/ - -API ---- - -### Version < v1.7.0 - -#### Create a new gist - -**POST** /{locale}/api/create -Params: - -* `form[title]`: String (required, can be empty) -* `form[type]`: String (required) - Values: html, css, javascript, php, sql, xml, yaml, perl, c, asp, python, bash, actionscript3, text -* `form[content]`: String (required) - -**Responses:** - -* Code `405`: Method Not Allowed -* Code `400`: Bad Request -* Code `200`: A json which contains gist's information. Example: - -```javascript -{ - "url": "https:\/\/gist.deblan.org\/en\/view\/55abcfa7771e0\/f4afbf72967dd95e3461490dcaa310d728d6a97d", - "gist": { - "Id": 66, - "Title": "test prod", - "Cipher": false, - "Type": "javascript", - "File": "55abcfa7771e0", - "CreatedAt": "2015-07-19T16:26:15Z", - "UpdatedAt": "2015-07-19T16:26:15Z" - } -} -``` - -#### Update an existing gist - -**POST** /{locale}/api/update/{id} -Params: - -* `{id}`: Gist Id (required) -* `form[content]`: String (required) - -**Responses:** - -* Code `405`: Method Not Allowed -* Code `400`: Bad Request -* Code `200`: A json which contains gist's information. Example: - -```javascript -{ - "url": "https:\/\/gist.deblan.org\/en\/view\/55abcfa7771e0\/abcgi72967dd95e3461490dcaa310d728d6adef", - "gist": { - "Id": 66, - "Title": "test prod", - "Cipher": false, - "Type": "javascript", - "File": "55abcfa7771e0", - "CreatedAt": "2015-07-19T16:26:15Z", - "UpdatedAt": "2015-07-19T16:30:15Z" - } -} -``` - -### Version >= v1.7.0 - -Invalid response codes: - -* Code `401`: Unauthorized -* Code `403`: API not enabled -* Code `405`: Method Not Allowed -* Code `400`: Bad Request - -#### List gists - -**GET** /{locale}/api/list/{apiToken} - -Response example: - -```javascript -[ - { - "id": 66, - "title": "test prod", - "cipher": false, - "type": "javascript", - "file": "55abcfa7771e0", - "createdAt": "2015-07-19T16:26:15Z", - "updatedAt": "2015-07-19T16:30:15Z" - "url": "https:\/\/gist.deblan.org\/en\/view\/55abcfa7771e0\/abcgi72967dd95e3461490dcaa310d728d6adef", - }, - { - "id": 67, - "title": "test prod 2", - "cipher": false, - "type": "javascript", - "file": "xyzbcfa7771e0", - "createdAt": "2015-08-19T16:26:15Z", - "updatedAt": "2015-08-19T16:30:15Z" - "url": "https:\/\/gist.deblan.org\/en\/view\/5byzbcfa7771e0\/def72967dd95e346koq0dcaa310d728d6artu", - }, - ... -] -``` - -#### Create a new gist - -**POST** /{locale}/api/create/{apiToken} -Params: - -* `form[title]`: String (required, can be empty) -* `form[type]`: String (required) - Values: html, css, javascript, php, sql, xml, yaml, perl, c, asp, python, bash, actionscript3, text -* `form[content]`: String (required) - -Response example: - -```javascript -{ - "url": "https:\/\/gist.deblan.org\/en\/view\/55abcfa7771e0\/f4afbf72967dd95e3461490dcaa310d728d6a97d", - "gist": { - "id": 66, - "title": "test prod", - "cipher": false, - "type": "javascript", - "file": "55abcfa7771e0", - "createdAt": "2015-07-19T16:26:15Z", - "updatedAt": "2015-07-19T16:26:15Z" - } -} -``` - -#### Update an existing gist - -**POST** /{locale}/api/update/{id}/{apiToken} -Params: - -* `{id}`: Gist Id (required) -* `form[content]`: String (required) - -Response example: - -```javascript -{ - "url": "https:\/\/gist.deblan.org\/en\/view\/55abcfa7771e0\/abcgi72967dd95e3461490dcaa310d728d6adef", - "gist": { - "id": 66, - "title": "test prod", - "cipher": false, - "type": "javascript", - "file": "55abcfa7771e0", - "createdAt": "2015-07-19T16:26:15Z", - "updatedAt": "2015-07-19T16:30:15Z" - } -} -``` - -#### Delete an existing gist - -**POST** /{locale}/api/delete/{id}/{apiToken} - -Response code `200`: - -```javascript -{"error":false} -``` - -Response code `400`: - -```javascript -{"message":"Invalid Gist", "error":true} -``` - -Console -------- - -* **Create a gist**: `$ app/console --help create` -* **Update a gist**: `$ app/console --help update` -* **Create user**: `app/console --help user:create` -* **Show stats**: `$ app/console --help stats` - -### Version >= v1.7.0 - -* **List your gists**: `$ app/console --help gists` -* **Delete a gist**: `$ app/console --help delete` - -Deployment ----------- - -Gist uses [Magallanes](http://magephp.com/) to manage deployment. - -**Global installation** - - $ composer global require andres-montanez/magallanes - # if the envvar PATH contains "$HOME/bin/" - $ ln -s ~/.composer/vendor/bin/mage ~/bin/mage - -**Local installation** - - $ composer require andres-montanez/magallanes - -There is an example of the configuration of an environment in `.mage/config/environment/prod.yml.dist`. - - # global installation - $ mage deploy to:prod - - # local installation - $ ./vendor/andres-montanez/magallanes/bin/mage deploy to:prod - -Contributors ------------- - -**Developers** - -* Simon Vieille - -**Translators** - -* Simon Vieille -* Marion Sanchez -* Marjorie Da Silva -* Mélanie Chanat -* Showfom +![Gist](https://upload.deblan.org/u/2018-08/5b7ab81c.png "Embeded Gist") diff --git a/app/bootstrap.php.d/20-twig.php b/app/bootstrap.php.d/20-twig.php index 8da7180..e69e1c6 100644 --- a/app/bootstrap.php.d/20-twig.php +++ b/app/bootstrap.php.d/20-twig.php @@ -9,6 +9,6 @@ $app->register(new TwigServiceProvider(), array( $app->extend('twig', function ($twig, $app) { $base = str_replace($app['request']->server->get('SCRIPT_NAME'), '', $app['request']->getBaseUrl()); $twig->addGlobal('web_path', $base.'/'); - + return $twig; }); diff --git a/app/bootstrap.php.d/30-trans.php b/app/bootstrap.php.d/30-trans.php index 9ec8a36..d65aa5d 100644 --- a/app/bootstrap.php.d/30-trans.php +++ b/app/bootstrap.php.d/30-trans.php @@ -11,7 +11,7 @@ use Symfony\Component\HttpFoundation\Cookie; $app->register(new TranslationServiceProvider(), array( 'locale' => 'en', 'locale_fallback' => 'en', - 'locales' => array('en', 'fr', 'es', 'de', 'cn'), + 'locales' => array('en', 'fr', 'es', 'de', 'cn', 'pl'), )); $app['translator'] = $app->extend('translator', function ($translator, $app) { diff --git a/app/bootstrap.php.d/80-cache.php b/app/bootstrap.php.d/80-cache.php new file mode 100644 index 0000000..3a28362 --- /dev/null +++ b/app/bootstrap.php.d/80-cache.php @@ -0,0 +1,8 @@ +register(new HttpCacheServiceProvider(), array( + 'http_cache.cache_dir' => $app['root_path'].'/cache/', + 'http_cache.esi' => null, +)); diff --git a/propel-dist.yaml b/app/config/propel.yaml.dist-mysql similarity index 84% rename from propel-dist.yaml rename to app/config/propel.yaml.dist-mysql index dd6f836..fa13d75 100644 --- a/propel-dist.yaml +++ b/app/config/propel.yaml.dist-mysql @@ -4,9 +4,9 @@ propel: default: adapter: mysql classname: Propel\Runtime\Connection\ConnectionWrapper - dsn: "mysql:host=localhost;dbname=gist" - user: root - password: root + dsn: "mysql:host=DATABASE_HOST;dbname=DATABASE_NAME" + user: "DATABASE_USERNAME" + password: "DATABASE_PASSWORD" settings: charset: utf8 queries: diff --git a/app/config/propel.yaml.dist-sqlite b/app/config/propel.yaml.dist-sqlite new file mode 100644 index 0000000..b11f6c7 --- /dev/null +++ b/app/config/propel.yaml.dist-sqlite @@ -0,0 +1,31 @@ +propel: + database: + connections: + default: + adapter: sqlite + classname: Propel\Runtime\Connection\ConnectionWrapper + dsn: "sqlite:DATABASE_PATH" + user: ~ + password: ~ + settings: + charset: utf8 + queries: + + paths: + projectDir: src/ + schemaDir: src/ + outputDir: src/ + phpDir: src/ + phpConfDir: app/config/propel + sqlDir: app/propel/sql + migrationDir: app/propel/migration + + runtime: + defaultConnection: default + connections: [default] + + generator: + defaultConnection: default + connections: [default] + objectModel: + addClassLevelComment: false diff --git a/app/locales/cn.yml b/app/locales/cn.yml index 2565198..c2adf88 100644 --- a/app/locales/cn.yml +++ b/app/locales/cn.yml @@ -38,14 +38,13 @@ gist: download: '下载' clone: '克隆' embed: '引用' - embed_copy: '复制' add: '新建' date: format: 'Y-m-d h:i:s' footer: - text: '

Powered by GIST, it''s open source :) - API

' + text: '

Powered by GIST, it''s open source :) - API

' login: login: @@ -99,6 +98,7 @@ form: php: 'PHP' sql: 'SQL' yaml: 'YAML' + markdown: 'MARKDOWN' perl: 'PERL' c: 'C/C++' asp: 'ASP' diff --git a/app/locales/de.yml b/app/locales/de.yml index 31f8f3f..656f71f 100644 --- a/app/locales/de.yml +++ b/app/locales/de.yml @@ -38,14 +38,13 @@ gist: download: 'Herunterladen' clone: 'Klonen' embed: 'Einfügen' - embed_copy: 'Kopieren' add: 'Hinzufügen' date: format: 'Y-m-d h:i:s' footer: - text: '

Powered by GIST, it''s open source :) - API

' + text: '

Powered by GIST, it''s open source :) - API

' login: login: @@ -99,6 +98,7 @@ form: php: 'PHP' sql: 'SQL' yaml: 'YAML' + markdown: 'MARKDOWN' perl: 'PERL' c: 'C/C++' asp: 'ASP' diff --git a/app/locales/en.yml b/app/locales/en.yml index 80a8360..40e7454 100644 --- a/app/locales/en.yml +++ b/app/locales/en.yml @@ -39,14 +39,13 @@ gist: download: 'Download' clone: 'Clone' embed: 'Embed' - embed_copy: 'Copy' add: 'New' date: format: 'Y-m-d h:i:s' footer: - text: '

Powered by GIST, it''s open source :) - API

' + text: '

Powered by GIST, it''s open source :) - API

' login: login: @@ -100,6 +99,7 @@ form: php: 'PHP' sql: 'SQL' yaml: 'YAML' + markdown: 'MARKDOWN' perl: 'PERL' c: 'C/C++' asp: 'ASP' diff --git a/app/locales/es.yml b/app/locales/es.yml index 11d89ed..83c0078 100644 --- a/app/locales/es.yml +++ b/app/locales/es.yml @@ -38,14 +38,13 @@ gist: download: 'Descargar' clone: 'Clonar' embed: 'Insertar' - embed_copy: 'Dupdo' add: 'Añadir' date: format: 'd/m/Y H\hi s\s' footer: - text: '

Impulsado por GIST, es libre :) - API

' + text: '

Impulsado por GIST, es libre :) - API

' login: login: @@ -99,6 +98,7 @@ form: php: 'PHP' sql: 'SQL' yaml: 'YAML' + markdown: 'MARKDOWN' perl: 'PERL' c: 'C/C++' asp: 'ASP' diff --git a/app/locales/fr.yml b/app/locales/fr.yml index e80d9cb..63c79ac 100644 --- a/app/locales/fr.yml +++ b/app/locales/fr.yml @@ -38,14 +38,13 @@ gist: download: 'Télécharger' clone: 'Clôner' embed: 'Insérer' - embed_copy: 'Copier' add: 'Ajouter' date: format: 'd/m/Y H\hi s\s' footer: - text: '

Propulsé par GIST, c''est libre :) - API

' + text: '

Propulsé par GIST, c''est libre :) - API

' login: login: @@ -99,6 +98,7 @@ form: php: 'PHP' sql: 'SQL' yaml: 'YAML' + markdown: 'MARKDOWN' perl: 'PERL' c: 'C/C++' asp: 'ASP' diff --git a/app/locales/pl.yml b/app/locales/pl.yml new file mode 100644 index 0000000..4eaf452 --- /dev/null +++ b/app/locales/pl.yml @@ -0,0 +1,109 @@ +app: + title: '#!GIST' + title_prefix: '#!GIST - ' + + menu: + home: + title: 'Home' + about: + title: 'O projekcie' + my: + login: + title: 'Logowanie' + logout: + title: 'Wylogowanie' + register: + title: 'Rejestracja' + my: + title: 'Konta' + +my: + title: 'Moje wklejki' + nothing: 'Nie ma jeszcze nic!' + api: + title: 'API' + warning: 'Trzymaj to w sekrecie!' + form: + generate: 'Wygeneruj nowy' + + +gist: + untitled: 'Bez tytułu' + 404: + title: 'Oops!' + message: 'Wklejka nie została znaleziona...' + action: + view: 'Podgląd' + history: 'Commit(s)' + raw: 'RAW' + download: 'Pobierz' + clone: 'Sklonuj' + embed: 'Embed' + add: 'Nowa' + +date: + format: 'Y-m-d h:i:s' + +footer: + text: '

Napędzane przez GIST, to jest open source :) - API

' + +login: + login: + title: 'Logowanie' + invalid: 'Nie prawidłowy login lub hasło.' + form: + username: + placeholder: 'Login' + password: + placeholder: 'Hasło' + remember_me: + label: 'Pamiętaj' + register: + title: 'Nowe konto' + already_exists: 'Ta nazwa użytkownika jest już zarejestrowana!' + registred: 'Gratulacje, twoje konto zostało utworzone!' + form: + username: + placeholder: 'Login' + current_password: + placeholder: 'Obecne hasło' + password: + placeholder: 'Hasło' + +form: + error: + password: 'Nie prawidłowe hasło.' + not_blank: 'To pole nie powinno być puste!' + title: + placeholder: 'Tytuł' + cipher: + label: 'Szyfrowanie: %value%' + choice: + anyway: 'Tak czy inaczej' + yes: 'Tak' + no: 'Nie' + submit: 'Wyślij' + filter: 'Filtr' + confirm: 'Potwierdzasz?' + success: + password: 'Hasło zostało zaktualizowane.' + gist: 'Wklejka została usunięta.' + type: + label: 'Język: %value%' + choice: + all: 'All' + html: 'HTML' + xml: 'XML' + css: 'CSS' + javascript: 'JAVASCRIPT' + php: 'PHP' + sql: 'SQL' + yaml: 'YAML' + markdown: 'MARKDOWN' + perl: 'PERL' + c: 'C/C++' + asp: 'ASP' + python: 'PYTHON' + bash: 'BASH' + actionscript3: 'ACTION SCRIPT' + text: 'TEXT' diff --git a/bower.json b/bower.json deleted file mode 100644 index 53891e7..0000000 --- a/bower.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "name": "gist", - "version": "0.0.3", - "authors": [ - "Simon Vieille " - ], - "description": "GIST is an open-source application to share code.", - "main": "web/index.php", - "keywords": [ - "Gist", - "GIT" - ], - "license": "LGPL", - "homepage": "https://gitnet.fr/deblan/gist", - "dependencies": { - "bootstrap": "3.3.4", - "flag-icon-css": "0.7.1", - "iframe-resizer": "2.8.6", - "jsdiff": "~2.2.2" - } -} diff --git a/composer.json b/composer.json index 510fa87..14cd8e1 100644 --- a/composer.json +++ b/composer.json @@ -1,4 +1,7 @@ { + "name": "deblan/gist", + "license": "GPL-3.0-only", + "type": "project", "require": { "silex/silex": "1.3.x-dev", "symfony/yaml": "~2.6", @@ -12,6 +15,17 @@ "guzzlehttp/guzzle": "~6.0", "symfony/security": "^2.7" }, + "scripts": { + "gist-scripts": [ + "Gist\\Composer\\PostInstallHandler::execute" + ], + "post-install-cmd": [ + "@gist-scripts" + ], + "post-update-cmd": [ + "@gist-scripts" + ] + }, "autoload": { "psr-0": { "": "src/" diff --git a/package.json b/package.json new file mode 100644 index 0000000..c637d1f --- /dev/null +++ b/package.json @@ -0,0 +1,9 @@ +{ + "dependencies": { + "bootstrap": "^3.4.1", + "diff": "^3.5.0", + "flag-icon-css": "^0.8.6", + "iframe-resizer": "^2.8.10", + "jquery": ">=3.4.0" + } +} diff --git a/src/Gist/Api/Client.php b/src/Gist/Api/Client.php index 82ed6cd..ca17817 100644 --- a/src/Gist/Api/Client.php +++ b/src/Gist/Api/Client.php @@ -88,7 +88,7 @@ class Client extends BaseClient public function update($gist, $content) { $response = $this->post( - str_replace('{gist}', $gist, $this->mergeApiKey(self::LIST)), + str_replace('{gist}', $gist, $this->mergeApiKey(self::UPDATE)), array( 'form_params' => array( 'form' => array( diff --git a/src/Gist/Composer/PostInstallHandler.php b/src/Gist/Composer/PostInstallHandler.php new file mode 100644 index 0000000..366cc24 --- /dev/null +++ b/src/Gist/Composer/PostInstallHandler.php @@ -0,0 +1,211 @@ + + */ +class PostInstallHandler +{ + public static function execute(Event $event) + { + $helper = new QuestionHelper(); + $input = new ArgvInput(); + $output = new ConsoleOutput(); + $filesystem = new Filesystem(); + + $output->writeln('+==============================+'); + $output->writeln('| GIST Setup |'); + $output->writeln('+==============================+'); + $output->writeln(''); + $output->writeln('1. Database'); + $output->writeln('==========='); + + $configure = true; + if ($filesystem->exists('propel.yaml')) { + $output->writeln('The configuration file exists.'); + $question = new ConfirmationQuestion('Your current configuration will not be merged. Do you want to override it? [y/N] ', false); + $configure = $helper->ask($input, $output, $question); + } else { + $configure = true; + } + + if ($configure) { + $choices = ['MySQL/MariaDB', 'SQLite', 'other']; + $question = new ChoiceQuestion('Which DBMS? ', $choices, 0); + $dbms = $helper->ask($input, $output, $question); + $substitutions = []; + + if ($dbms === 'MySQL/MariaDB') { + $templateName = 'propel.yaml.dist-mysql'; + + $question = new Question('Host: [127.0.0.1] ', '127.0.0.1'); + $substitutions['DATABASE_HOST'] = $helper->ask($input, $output, $question); + + $question = new Question('Database (it must exists!): [gist] ', 'gist'); + $substitutions['DATABASE_NAME'] = $helper->ask($input, $output, $question); + + $question = new Question('Username: [root] ', 'root'); + $substitutions['DATABASE_USERNAME'] = $helper->ask($input, $output, $question); + + $question = new Question('Password: [] ', ''); + $substitutions['DATABASE_PASSWORD'] = $helper->ask($input, $output, $question); + } elseif ($dbms === 'SQLite') { + $defaultPath = getcwd().'/data/gist.sqlite'; + $question = new Question("Ok! Where do you want me to save datas? [$defaultPath] ", $defaultPath); + $substitutions['DATABASE_PATH'] = $helper->ask($input, $output, $question); + $templateName = 'propel.yaml.dist-sqlite'; + } else { + $output->writeln('See README.md to perform the configuration.'); + + return; + } + + $template = file_get_contents('app/config/'.$templateName); + $content = str_replace( + array_keys($substitutions), + array_values($substitutions), + $template + ); + + $done = file_put_contents('propel.yaml', $content) !== false; + + if ($done) { + $output->writeln('Running migration...'); + + foreach (['config:convert', 'model:build --recursive', 'migration:diff --recursive', 'migration:migrate --recursive'] as $arg) { + $command = self::getPhp(true).' ./vendor/propel/propel/bin/propel '.$arg; + $process = new Process($command); + $process->run(); + + if (!$process->isSuccessful()) { + $output->writeln('An error occured while executing:'); + $output->writeln($command); + $output->writeln('To perform the configuration. See README.md.'); + + return; + } + } + + $output->writeln('Done!'); + } else { + $output->writeln('An error occured. See README.md to perform the configuration.'); + } + } + + $output->writeln(''); + $output->writeln('2. Application'); + $output->writeln('=============='); + + $configure = true; + if ($filesystem->exists('app/config/config.yml')) { + $output->writeln('The configuration file exists.'); + $question = new ConfirmationQuestion('Your current configuration will not be merged. Do you want to override it? [y/N] ', false); + $configure = $helper->ask($input, $output, $question); + } else { + $configure = true; + } + + if ($configure) { + $output->writeln(''); + $output->writeln(' 2.1 Security'); + $output->writeln('-------------'); + + $token = str_shuffle(sha1(microtime().uniqid())); + + $question = new ConfirmationQuestion('Registration enabled: [Y/n] ', true); + $enableRegistration = $helper->ask($input, $output, $question); + + $question = new ConfirmationQuestion('Login enabled: [Y/n] ', true); + $enableLogin = $helper->ask($input, $output, $question); + + $question = new ConfirmationQuestion('Login required to edit a gist: [y/N] ', false); + $loginRequiredToEditGist = $helper->ask($input, $output, $question); + + $question = new ConfirmationQuestion('Login required to view a gist: [y/N] ', false); + $loginRequiredToViewGist = $helper->ask($input, $output, $question); + + $question = new ConfirmationQuestion('Login required to view an embeded gist: [y/N] ', false); + $loginRequiredToViewEmbededGist = $helper->ask($input, $output, $question); + + $output->writeln(''); + $output->writeln(' 2.2 API'); + $output->writeln('--------'); + + $question = new ConfirmationQuestion('API enabled: [Y/n] ', true); + $apiEnabled = $helper->ask($input, $output, $question); + + if ($apiEnabled) { + $question = new ConfirmationQuestion('API key required: [y/N] ', false); + $apikeyRequired = $helper->ask($input, $output, $question); + } else { + $apikeyRequired = false; + } + + $question = new Question('[Client] API base URL: [https://gist.deblan.org/] ', 'https://gist.deblan.org/'); + $apiBaseUrl = $helper->ask($input, $output, $question); + + $question = new Question('[Client] API key: [] ', ''); + $apiClientApiKey = $helper->ask($input, $output, $question); + + $configuration = [ + 'security' => [ + 'token' => $token, + 'enable_registration' => $enableRegistration, + 'enable_login' => $enableLogin, + 'login_required_to_edit_gist' => $loginRequiredToEditGist, + 'login_required_to_view_gist' => $loginRequiredToViewGist, + 'login_required_to_view_embeded_gist' => $loginRequiredToViewEmbededGist, + ], + 'api' => [ + 'enabled' => $apiEnabled, + 'api_key_required' => $apikeyRequired, + 'base_url' => $apiBaseUrl, + 'client' => [ + 'api_key' => $apiClientApiKey, + ], + ], + 'data' => [ + 'path' => 'data/git', + ], + 'git' => [ + 'path' => '/usr/bin/git', + ], + 'theme' => [ + 'name' => 'dark', + ], + ]; + + $content = (new Yaml())->dump($configuration); + + $done = file_put_contents('app/config/config.yml', $content); + } + + $output->writeln(''); + $output->writeln('Configuration finished!'); + } + + protected static function getPhp($includeArgs = true) + { + $phpFinder = new PhpExecutableFinder(); + if (!$phpPath = $phpFinder->find($includeArgs)) { + throw new \RuntimeException('The php executable could not be found, add it to your PATH environment variable and try again'); + } + + return $phpPath; + } +} diff --git a/src/Gist/Controller/ApiController.php b/src/Gist/Controller/ApiController.php index 89e18e1..283a616 100644 --- a/src/Gist/Controller/ApiController.php +++ b/src/Gist/Controller/ApiController.php @@ -158,12 +158,16 @@ class ApiController extends Controller return $this->invalidMethodResponse('POST method is required.'); } - $gist = GistQuery::create() - ->filterByCipher(false) - ->filterById((int) $gist) - ->_or() - ->filterByFile($gist) - ->findOne(); + $query = GistQuery::create() + ->filterByCipher(false); + + if (ctype_digit($gist)) { + $query->filterById((int) $gist); + } else { + $query->filterByFile($gist); + } + + $gist = $query->findOne(); if (!$gist) { return $this->invalidRequestResponse('Invalid Gist'); diff --git a/src/Gist/Controller/Controller.php b/src/Gist/Controller/Controller.php index 5e71381..c13fd38 100644 --- a/src/Gist/Controller/Controller.php +++ b/src/Gist/Controller/Controller.php @@ -20,6 +20,27 @@ abstract class Controller */ protected $app; + /** + * @var array + */ + protected $types = [ + 'html', + 'css', + 'javascript', + 'php', + 'sql', + 'xml', + 'yaml', + 'markdown', + 'perl', + 'c', + 'asp', + 'python', + 'bash', + 'actionscript3', + 'text', + ]; + /** * __construct. * @@ -88,6 +109,7 @@ abstract class Controller return array( 'gist' => $gist, 'type' => $gist->getType(), + 'types' => $this->types, 'history' => $history, 'commit' => $commit, 'raw_content' => $content, @@ -136,7 +158,6 @@ abstract class Controller $app = $this->getApp(); if (!empty($request)) { - } $securityContext = $app['security.token_storage']; @@ -180,4 +201,32 @@ abstract class Controller $params ); } + + /** + * Creates a Response. + * + * @param string $template + * @param array $params + * + * @return Response + */ + public function createResponse($template, array $params = null) + { + $body = $this->render($template, $params); + + $response = new Response($body); + + if (empty($params['no_cache'])) { + $ttl = 3600 * 24 * 7; + $etag = sha1($response->getContent()); + + $response->setTtl($ttl); + $response->setClientTtl($ttl); + $response->setExpires(new \DateTime('now +7 days')); + $response->setLastModified(new \DateTime('now')); + $response->setEtag($etag, true); + } + + return $response; + } } diff --git a/src/Gist/Controller/EditController.php b/src/Gist/Controller/EditController.php index 1767dce..bafdf49 100644 --- a/src/Gist/Controller/EditController.php +++ b/src/Gist/Controller/EditController.php @@ -9,6 +9,7 @@ use Gist\Model\Gist; use GitWrapper\GitException; use Symfony\Component\HttpFoundation\RedirectResponse; use Symfony\Component\Form\FormError; +use Symfony\Component\HttpFoundation\Response; /** * Class EditController. @@ -22,7 +23,7 @@ class EditController extends Controller * * @param Request $request * - * @return string + * @return Response */ public function createAction(Request $request) { @@ -54,11 +55,12 @@ class EditController extends Controller } } - return $this->render( + return $this->createResponse( 'Edit/index.html.twig', array( 'gist' => isset($gist) ? $gist : null, 'form' => $form->createView(), + 'no_cache' => true, ) ); } @@ -68,7 +70,7 @@ class EditController extends Controller * * @param Request $request * - * @return string + * @return Response */ public function cloneAction(Request $request, $gist, $commit) { @@ -108,7 +110,8 @@ class EditController extends Controller } $viewOptions['form'] = $form->createView(); + $viewOptions['no_cache'] = true; - return $this->render('Edit/clone.html.twig', $viewOptions); + return $this->createResponse('Edit/clone.html.twig', $viewOptions); } } diff --git a/src/Gist/Controller/LoginController.php b/src/Gist/Controller/LoginController.php index f835306..eecff06 100644 --- a/src/Gist/Controller/LoginController.php +++ b/src/Gist/Controller/LoginController.php @@ -20,7 +20,7 @@ class LoginController extends Controller * * @param Request $request * - * @return string + * @return Response */ public function registerAction(Request $request) { @@ -57,12 +57,13 @@ class LoginController extends Controller } } - return $this->render( + return $this->createResponse( 'Login/register.html.twig', [ 'form' => $form->createView(), 'error' => isset($error) ? $error : '', 'success' => isset($success) ? $success : '', + 'no_cache' => true, ] ); } @@ -72,7 +73,7 @@ class LoginController extends Controller * * @param Request $request * - * @return string + * @return Response */ public function loginAction(Request $request) { @@ -97,11 +98,12 @@ class LoginController extends Controller $error = $app['translator']->trans('login.login.invalid'); } - return $this->render( + return $this->createResponse( 'Login/login.html.twig', [ 'form' => $form->createView(), 'error' => isset($error) ? $error : '', + 'no_cache' => true, ] ); } diff --git a/src/Gist/Controller/MyController.php b/src/Gist/Controller/MyController.php index d59f315..b3224a5 100644 --- a/src/Gist/Controller/MyController.php +++ b/src/Gist/Controller/MyController.php @@ -7,6 +7,7 @@ use Gist\Form\DeleteGistForm; use Gist\Form\FilterGistForm; use Gist\Form\UserPasswordForm; use Symfony\Component\HttpFoundation\RedirectResponse; +use Symfony\Component\HttpFoundation\Response; /** * Class MyController. @@ -21,7 +22,7 @@ class MyController extends Controller * @param Request $request * @param int $page * - * @return string + * @return Response */ public function myAction(Request $request, $page) { @@ -62,7 +63,7 @@ class MyController extends Controller if (empty($apiKey)) { $regenerateApiKey = true; - } + } // FIXME: CSRF issue! elseif ($request->request->get('apiKey') === $apiKey && $request->request->has('generateApiKey')) { $regenerateApiKey = true; @@ -119,7 +120,7 @@ class MyController extends Controller } } - return $this->render( + return $this->createResponse( 'My/my.html.twig', array( 'gists' => $gists, @@ -129,6 +130,7 @@ class MyController extends Controller 'filterForm' => $filterForm->createView(), 'passwordForm' => $passwordForm->createView(), 'deleted' => !empty($deleted), + 'no_cache' => true, ) ); } diff --git a/src/Gist/Controller/ViewController.php b/src/Gist/Controller/ViewController.php index fd9f262..8ea5002 100644 --- a/src/Gist/Controller/ViewController.php +++ b/src/Gist/Controller/ViewController.php @@ -31,7 +31,18 @@ class ViewController extends Controller $viewOptions = $this->getViewOptions($request, $gist, $commit); if (is_array($viewOptions)) { - return $this->render('View/view.html.twig', $viewOptions); + if ($request->query->has('type')) { + $type = $request->query->get('type'); + + if (in_array($type, $this->types)) { + $viewOptions['gist']->setType($type); + $viewOptions['type_overrided'] = true; + } + } + + $viewOptions['no_cache'] = true; + + return $this->createResponse('View/view.html.twig', $viewOptions); } else { return $this->notFoundResponse(); } @@ -53,7 +64,16 @@ class ViewController extends Controller $viewOptions = $this->getViewOptions($request, $gist, $commit); if (is_array($viewOptions)) { - return $app['twig']->render('View/embed.html.twig', $viewOptions); + if ($request->query->has('type')) { + $type = $request->query->get('type'); + + if (in_array($type, $this->types)) { + $viewOptions['gist']->setType($type); + $viewOptions['type_overrided'] = true; + } + } + + return $this->createResponse('View/embed.html.twig', $viewOptions); } else { return $this->notFoundResponse(); } @@ -66,19 +86,25 @@ class ViewController extends Controller * @param string $gist Gist's ID * @param string $commit The commit * - * @return string|Response + * @return Response */ public function embedJsAction(Request $request, $gist, $commit) { $viewOptions = $this->getViewOptions($request, $gist, $commit); - return new Response( - $this->render('View/embedJs.html.twig', $viewOptions), - 200, - array( - 'Content-Type' => 'text/javascript', - ) - ); + if ($request->query->has('type')) { + $type = $request->query->get('type'); + + if (in_array($type, $this->types)) { + $viewOptions['gist']->setType($type); + $viewOptions['type_overrided'] = true; + } + } + + $response = $this->createResponse('View/embedJs.html.twig', $viewOptions); + $response->headers->set('Content-Type', 'text/javascript'); + + return $response; } /** @@ -88,7 +114,7 @@ class ViewController extends Controller * @param string $gist Gist's ID * @param string $commit The commit * - * @return string|Response + * @return Response */ public function rawAction(Request $request, $gist, $commit) { @@ -114,7 +140,7 @@ class ViewController extends Controller * @param string $gist Gist's ID * @param string $commit The commit * - * @return string|Response + * @return Response */ public function downloadAction(Request $request, $gist, $commit) { @@ -131,9 +157,10 @@ class ViewController extends Controller 200, array( 'Content-Disposition' => sprintf('filename=%s.%s', $gist->getFile(), $gist->getTypeAsExtension()), - 'Content-Length' => filesize($file), + 'Content-Length' => mb_strlen($viewOptions['raw_content']), 'Content-Type' => 'application/force-download', - ) + ), + false ); } else { return $this->notFoundResponse($app); @@ -146,7 +173,7 @@ class ViewController extends Controller * @param Request $request * @param string $gist Gist's ID * - * @return string|Response + * @return Response */ public function revisionsAction(Request $request, $gist) { @@ -164,7 +191,7 @@ class ViewController extends Controller return $this->notFoundResponse(); } - return $this->render( + return $this->createResponse( 'View/revisions.html.twig', array( 'gist' => $gist, diff --git a/src/Gist/Form/CreateGistForm.php b/src/Gist/Form/CreateGistForm.php index 060f444..3972796 100644 --- a/src/Gist/Form/CreateGistForm.php +++ b/src/Gist/Form/CreateGistForm.php @@ -97,6 +97,7 @@ class CreateGistForm extends AbstractForm 'sql' => '', 'xml' => '', 'yaml' => '', + 'markdown' => '', 'perl' => '', 'c' => '', 'asp' => '', diff --git a/src/Gist/Model/Gist.php b/src/Gist/Model/Gist.php index 54142bc..90d8259 100644 --- a/src/Gist/Model/Gist.php +++ b/src/Gist/Model/Gist.php @@ -75,6 +75,7 @@ class Gist extends BaseGist 'bash' => 'sh', 'actionscript3' => 'as', 'text' => 'txt', + 'markdown' => 'md', ); return str_replace(array_keys($data), array_values($data), $this->getType()); diff --git a/src/Gist/Resources/public b/src/Gist/Resources/public new file mode 120000 index 0000000..55a9cd7 --- /dev/null +++ b/src/Gist/Resources/public @@ -0,0 +1 @@ +../../../web/app/ \ No newline at end of file diff --git a/src/Gist/Resources/views/View/embed.html.twig b/src/Gist/Resources/views/View/embed.html.twig index 4e74e30..d1ee417 100644 --- a/src/Gist/Resources/views/View/embed.html.twig +++ b/src/Gist/Resources/views/View/embed.html.twig @@ -3,6 +3,14 @@ {% block css %} {{ parent() }} + + + {% if theme_settings.name == 'dark' %} + + {% else %} + + {% endif %} +