commit 9b920daefa2d868d63c8710808871237bad2376a Author: Toby Zerner Date: Tue Aug 4 17:19:17 2015 +0930 Initial commit diff --git a/extensions/pusher/.editorconfig b/extensions/pusher/.editorconfig new file mode 100644 index 000000000..5612a5e74 --- /dev/null +++ b/extensions/pusher/.editorconfig @@ -0,0 +1,32 @@ +# EditorConfig helps developers define and maintain consistent +# coding styles between different editors and IDEs +# editorconfig.org + +root = true + +[*] +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +indent_style = space +indent_size = 2 + +[*.js] +indent_style = space +indent_size = 2 + +[*.{css,less}] +indent_style = space +indent_size = 2 + +[*.html] +indent_style = space +indent_size = 2 + +[*.{diff,md}] +trim_trailing_whitespace = false + +[*.php] +indent_style = space +indent_size = 4 diff --git a/extensions/pusher/.eslintignore b/extensions/pusher/.eslintignore new file mode 100644 index 000000000..86b7c8854 --- /dev/null +++ b/extensions/pusher/.eslintignore @@ -0,0 +1,5 @@ +**/bower_components/**/* +**/node_modules/**/* +vendor/**/* +**/Gulpfile.js +**/dist/**/* diff --git a/extensions/pusher/.eslintrc b/extensions/pusher/.eslintrc new file mode 100644 index 000000000..9cebc759d --- /dev/null +++ b/extensions/pusher/.eslintrc @@ -0,0 +1,171 @@ +{ + "parser": "babel-eslint", // https://github.com/babel/babel-eslint + "env": { // http://eslint.org/docs/user-guide/configuring.html#specifying-environments + "browser": true // browser global variables + }, + "ecmaFeatures": { + "arrowFunctions": true, + "blockBindings": true, + "classes": true, + "defaultParams": true, + "destructuring": true, + "forOf": true, + "generators": false, + "modules": true, + "objectLiteralComputedProperties": true, + "objectLiteralDuplicateProperties": false, + "objectLiteralShorthandMethods": true, + "objectLiteralShorthandProperties": true, + "spread": true, + "superInFunctions": true, + "templateStrings": true, + "jsx": true + }, + "globals": { + "m": true, + "app": true, + "$": true, + "moment": true + }, + "rules": { +/** + * Strict mode + */ + // babel inserts "use strict"; for us + "strict": [2, "never"], // http://eslint.org/docs/rules/strict + +/** + * ES6 + */ + "no-var": 2, // http://eslint.org/docs/rules/no-var + "prefer-const": 2, // http://eslint.org/docs/rules/prefer-const + +/** + * Variables + */ + "no-shadow": 2, // http://eslint.org/docs/rules/no-shadow + "no-shadow-restricted-names": 2, // http://eslint.org/docs/rules/no-shadow-restricted-names + "no-unused-vars": [2, { // http://eslint.org/docs/rules/no-unused-vars + "vars": "local", + "args": "after-used" + }], + "no-use-before-define": 2, // http://eslint.org/docs/rules/no-use-before-define + +/** + * Possible errors + */ + "comma-dangle": [2, "never"], // http://eslint.org/docs/rules/comma-dangle + "no-cond-assign": [2, "always"], // http://eslint.org/docs/rules/no-cond-assign + "no-console": 1, // http://eslint.org/docs/rules/no-console + "no-debugger": 1, // http://eslint.org/docs/rules/no-debugger + "no-alert": 1, // http://eslint.org/docs/rules/no-alert + "no-constant-condition": 1, // http://eslint.org/docs/rules/no-constant-condition + "no-dupe-keys": 2, // http://eslint.org/docs/rules/no-dupe-keys + "no-duplicate-case": 2, // http://eslint.org/docs/rules/no-duplicate-case + "no-empty": 2, // http://eslint.org/docs/rules/no-empty + "no-ex-assign": 2, // http://eslint.org/docs/rules/no-ex-assign + "no-extra-boolean-cast": 0, // http://eslint.org/docs/rules/no-extra-boolean-cast + "no-extra-semi": 2, // http://eslint.org/docs/rules/no-extra-semi + "no-func-assign": 2, // http://eslint.org/docs/rules/no-func-assign + "no-inner-declarations": 2, // http://eslint.org/docs/rules/no-inner-declarations + "no-invalid-regexp": 2, // http://eslint.org/docs/rules/no-invalid-regexp + "no-irregular-whitespace": 2, // http://eslint.org/docs/rules/no-irregular-whitespace + "no-obj-calls": 2, // http://eslint.org/docs/rules/no-obj-calls + "no-reserved-keys": 2, // http://eslint.org/docs/rules/no-reserved-keys + "no-sparse-arrays": 2, // http://eslint.org/docs/rules/no-sparse-arrays + "no-unreachable": 2, // http://eslint.org/docs/rules/no-unreachable + "use-isnan": 2, // http://eslint.org/docs/rules/use-isnan + "block-scoped-var": 2, // http://eslint.org/docs/rules/block-scoped-var + +/** + * Best practices + */ + "consistent-return": 2, // http://eslint.org/docs/rules/consistent-return + "curly": [2, "multi-line"], // http://eslint.org/docs/rules/curly + "default-case": 2, // http://eslint.org/docs/rules/default-case + "dot-notation": [2, { // http://eslint.org/docs/rules/dot-notation + "allowKeywords": true + }], + "eqeqeq": 2, // http://eslint.org/docs/rules/eqeqeq + "no-caller": 2, // http://eslint.org/docs/rules/no-caller + "no-else-return": 2, // http://eslint.org/docs/rules/no-else-return + "no-eq-null": 2, // http://eslint.org/docs/rules/no-eq-null + "no-eval": 2, // http://eslint.org/docs/rules/no-eval + "no-extend-native": 2, // http://eslint.org/docs/rules/no-extend-native + "no-extra-bind": 2, // http://eslint.org/docs/rules/no-extra-bind + "no-fallthrough": 2, // http://eslint.org/docs/rules/no-fallthrough + "no-floating-decimal": 2, // http://eslint.org/docs/rules/no-floating-decimal + "no-implied-eval": 2, // http://eslint.org/docs/rules/no-implied-eval + "no-lone-blocks": 2, // http://eslint.org/docs/rules/no-lone-blocks + "no-loop-func": 2, // http://eslint.org/docs/rules/no-loop-func + "no-multi-str": 2, // http://eslint.org/docs/rules/no-multi-str + "no-native-reassign": 2, // http://eslint.org/docs/rules/no-native-reassign + "no-new": 2, // http://eslint.org/docs/rules/no-new + "no-new-func": 2, // http://eslint.org/docs/rules/no-new-func + "no-new-wrappers": 2, // http://eslint.org/docs/rules/no-new-wrappers + "no-octal": 2, // http://eslint.org/docs/rules/no-octal + "no-octal-escape": 2, // http://eslint.org/docs/rules/no-octal-escape + "no-param-reassign": 2, // http://eslint.org/docs/rules/no-param-reassign + "no-proto": 2, // http://eslint.org/docs/rules/no-proto + "no-redeclare": 2, // http://eslint.org/docs/rules/no-redeclare + "no-return-assign": 2, // http://eslint.org/docs/rules/no-return-assign + "no-self-compare": 2, // http://eslint.org/docs/rules/no-self-compare + "no-sequences": 2, // http://eslint.org/docs/rules/no-sequences + "no-throw-literal": 2, // http://eslint.org/docs/rules/no-throw-literal + "no-with": 2, // http://eslint.org/docs/rules/no-with + "radix": 2, // http://eslint.org/docs/rules/radix + "vars-on-top": 2, // http://eslint.org/docs/rules/vars-on-top + "wrap-iife": [2, "any"], // http://eslint.org/docs/rules/wrap-iife + "yoda": 2, // http://eslint.org/docs/rules/yoda + +/** + * Style + */ + "indent": [2, 2], // http://eslint.org/docs/rules/indent + "brace-style": [2, // http://eslint.org/docs/rules/brace-style + "1tbs", { + "allowSingleLine": true + }], + "quotes": [ + 2, "single", "avoid-escape" // http://eslint.org/docs/rules/quotes + ], + "camelcase": [2, { // http://eslint.org/docs/rules/camelcase + "properties": "never" + }], + "comma-spacing": [2, { // http://eslint.org/docs/rules/comma-spacing + "before": false, + "after": true + }], + "comma-style": [2, "last"], // http://eslint.org/docs/rules/comma-style + "eol-last": 2, // http://eslint.org/docs/rules/eol-last + "func-names": 1, // http://eslint.org/docs/rules/func-names + "key-spacing": [2, { // http://eslint.org/docs/rules/key-spacing + "beforeColon": false, + "afterColon": true + }], + "new-cap": [2, { // http://eslint.org/docs/rules/new-cap + "newIsCap": true + }], + "no-multiple-empty-lines": [2, { // http://eslint.org/docs/rules/no-multiple-empty-lines + "max": 2 + }], + "no-new-object": 2, // http://eslint.org/docs/rules/no-new-object + "no-spaced-func": 2, // http://eslint.org/docs/rules/no-spaced-func + "no-trailing-spaces": 2, // http://eslint.org/docs/rules/no-trailing-spaces + "no-wrap-func": 2, // http://eslint.org/docs/rules/no-wrap-func + "no-underscore-dangle": 0, // http://eslint.org/docs/rules/no-underscore-dangle + "one-var": [2, "never"], // http://eslint.org/docs/rules/one-var + "padded-blocks": [2, "never"], // http://eslint.org/docs/rules/padded-blocks + "semi": [2, "always"], // http://eslint.org/docs/rules/semi + "semi-spacing": [2, { // http://eslint.org/docs/rules/semi-spacing + "before": false, + "after": true + }], + "space-after-keywords": 2, // http://eslint.org/docs/rules/space-after-keywords + "space-before-blocks": 2, // http://eslint.org/docs/rules/space-before-blocks + "space-before-function-paren": [2, "never"], // http://eslint.org/docs/rules/space-before-function-paren + "space-infix-ops": 2, // http://eslint.org/docs/rules/space-infix-ops + "space-return-throw-case": 2, // http://eslint.org/docs/rules/space-return-throw-case + "spaced-line-comment": 2, // http://eslint.org/docs/rules/spaced-line-comment + } +} diff --git a/extensions/pusher/.gitignore b/extensions/pusher/.gitignore new file mode 100644 index 000000000..a4f3b125e --- /dev/null +++ b/extensions/pusher/.gitignore @@ -0,0 +1,4 @@ +/vendor +composer.phar +.DS_Store +Thumbs.db diff --git a/extensions/pusher/bootstrap.php b/extensions/pusher/bootstrap.php new file mode 100644 index 000000000..08fe7a953 --- /dev/null +++ b/extensions/pusher/bootstrap.php @@ -0,0 +1,10 @@ +=5.2" + }, + "require-dev": { + "phpunit/phpunit": "~4" + }, + "type": "library", + "autoload": { + "classmap": [ + "lib/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "description": "Library for interacting with the Pusher REST API", + "homepage": "https://github.com/pusher/pusher-php-server", + "keywords": [ + "events", + "php-pusher-server", + "publish", + "pusher", + "realtime", + "rest", + "trigger" + ], + "time": "2015-05-13 11:01:46" + } + ], + "packages-dev": [], + "aliases": [], + "minimum-stability": "stable", + "stability-flags": [], + "prefer-stable": false, + "prefer-lowest": false, + "platform": [], + "platform-dev": [] +} diff --git a/extensions/pusher/flarum.json b/extensions/pusher/flarum.json new file mode 100644 index 000000000..e53162d99 --- /dev/null +++ b/extensions/pusher/flarum.json @@ -0,0 +1,16 @@ +{ + "name": "pusher", + "title": "Pusher", + "description": "See new discussions and posts in real-time using Pusher.", + "keywords": [], + "version": "0.1.0", + "author": { + "name": "Toby Zerner", + "email": "toby.zerner@gmail.com" + }, + "license": "MIT", + "require": { + "php": ">=5.4.0", + "flarum": ">0.1.0" + } +} \ No newline at end of file diff --git a/extensions/pusher/js/.gitignore b/extensions/pusher/js/.gitignore new file mode 100644 index 000000000..372e20a51 --- /dev/null +++ b/extensions/pusher/js/.gitignore @@ -0,0 +1,3 @@ +bower_components +node_modules +dist diff --git a/extensions/pusher/js/admin/Gulpfile.js b/extensions/pusher/js/admin/Gulpfile.js new file mode 100644 index 000000000..c893c3cc3 --- /dev/null +++ b/extensions/pusher/js/admin/Gulpfile.js @@ -0,0 +1,7 @@ +var gulp = require('flarum-gulp'); + +gulp({ + modules: { + 'pusher': 'src/**/*.js' + } +}); diff --git a/extensions/pusher/js/admin/package.json b/extensions/pusher/js/admin/package.json new file mode 100644 index 000000000..3e0ef919d --- /dev/null +++ b/extensions/pusher/js/admin/package.json @@ -0,0 +1,7 @@ +{ + "private": true, + "devDependencies": { + "gulp": "^3.8.11", + "flarum-gulp": "git+https://github.com/flarum/gulp.git" + } +} diff --git a/extensions/pusher/js/admin/src/components/PusherSettingsModal.js b/extensions/pusher/js/admin/src/components/PusherSettingsModal.js new file mode 100644 index 000000000..1dbf02c88 --- /dev/null +++ b/extensions/pusher/js/admin/src/components/PusherSettingsModal.js @@ -0,0 +1,71 @@ +import Modal from 'flarum/components/Modal'; +import Button from 'flarum/components/Button'; +import saveConfig from 'flarum/utils/saveConfig'; + +export default class PusherSettingsModal extends Modal { + constructor(...args) { + super(...args); + + this.appId = m.prop(app.config['pusher.app_id'] || ''); + this.appKey = m.prop(app.config['pusher.app_key'] || ''); + this.appSecret = m.prop(app.config['pusher.app_secret'] || ''); + } + + className() { + return 'PusherSettingsModal Modal--small'; + } + + title() { + return 'Pusher Settings'; + } + + content() { + return ( +
+
+
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ {Button.component({ + type: 'submit', + className: 'Button Button--primary PusherSettingsModal-save', + loading: this.loading, + children: 'Save Changes' + })} +
+
+
+ ); + } + + onsubmit(e) { + e.preventDefault(); + + this.loading = true; + + saveConfig({ + 'pusher.app_id': this.appId(), + 'pusher.app_key': this.appKey(), + 'pusher.app_secret': this.appSecret() + }).then( + () => this.hide(), + () => { + this.loading = false; + m.redraw(); + } + ); + } +} diff --git a/extensions/pusher/js/admin/src/main.js b/extensions/pusher/js/admin/src/main.js new file mode 100644 index 000000000..b52fc99c7 --- /dev/null +++ b/extensions/pusher/js/admin/src/main.js @@ -0,0 +1,8 @@ +import { extend } from 'flarum/extend'; +import app from 'flarum/app'; + +import PusherSettingsModal from 'pusher/components/PusherSettingsModal'; + +app.initializers.add('pusher', app => { + app.extensionSettings.pusher = () => app.modal.show(new PusherSettingsModal()); +}); diff --git a/extensions/pusher/js/forum/Gulpfile.js b/extensions/pusher/js/forum/Gulpfile.js new file mode 100644 index 000000000..c893c3cc3 --- /dev/null +++ b/extensions/pusher/js/forum/Gulpfile.js @@ -0,0 +1,7 @@ +var gulp = require('flarum-gulp'); + +gulp({ + modules: { + 'pusher': 'src/**/*.js' + } +}); diff --git a/extensions/pusher/js/forum/package.json b/extensions/pusher/js/forum/package.json new file mode 100644 index 000000000..3e0ef919d --- /dev/null +++ b/extensions/pusher/js/forum/package.json @@ -0,0 +1,7 @@ +{ + "private": true, + "devDependencies": { + "gulp": "^3.8.11", + "flarum-gulp": "git+https://github.com/flarum/gulp.git" + } +} diff --git a/extensions/pusher/js/forum/src/main.js b/extensions/pusher/js/forum/src/main.js new file mode 100644 index 000000000..a48a6d0b8 --- /dev/null +++ b/extensions/pusher/js/forum/src/main.js @@ -0,0 +1,82 @@ +/*global Pusher*/ + +import { extend } from 'flarum/extend'; +import app from 'flarum/app'; +import DiscussionList from 'flarum/components/DiscussionList'; +import DiscussionPage from 'flarum/components/DiscussionPage'; +import IndexPage from 'flarum/components/IndexPage'; + +app.initializers.add('pusher', () => { + const loadPusher = m.deferred(); + + $.getScript('//js.pusher.com/3.0/pusher.min.js', () => { + loadPusher.resolve(new Pusher(app.forum.attribute('pusherKey')).subscribe('public')); + }); + + app.pusher = loadPusher.promise; + app.pushedUpdates = []; + + extend(DiscussionList.prototype, 'config', function(x, isInitialized, context) { + if (isInitialized) return; + + app.pusher.then(channel => { + channel.bind('newPost', data => { + const params = this.props.params; + + if (!params.q && !params.sort) { + if (params.tags) { + const tag = app.store.getBy('tags', 'slug', params.tags); + + if (data.tagIds.indexOf(tag.id()) === -1) return; + } + + if ((!app.current.discussion || data.discussionId !== app.current.discussion.id()) && app.pushedUpdates.indexOf(data.discussionId) === -1) { + app.pushedUpdates.push(data.discussionId); + m.redraw(); + } + } + }); + + context.onunload = () => channel.unbind(); + }); + }); + + extend(DiscussionList.prototype, 'view', function(vdom) { + if (app.pushedUpdates) { + const count = app.pushedUpdates.length; + + if (count) { + vdom.children.unshift( + + ); + } + } + }); + + extend(DiscussionPage.prototype, 'config', function(x, isInitialized, context) { + if (isInitialized) return; + + app.pusher.then(channel => { + channel.bind('newPost', data => { + if (this.discussion && this.discussion.id() === data.discussionId && this.stream) { + app.store.find('discussions', this.discussion.id()).then(() => this.stream.update()); + } + }); + + context.onunload = () => channel.unbind(); + }); + }); + + extend(IndexPage.prototype, 'actionItems', items => { + delete items.refresh; + }); +}); diff --git a/extensions/pusher/less/admin/extension.less b/extensions/pusher/less/admin/extension.less new file mode 100644 index 000000000..e69de29bb diff --git a/extensions/pusher/less/forum/extension.less b/extensions/pusher/less/forum/extension.less new file mode 100644 index 000000000..5e5b80743 --- /dev/null +++ b/extensions/pusher/less/forum/extension.less @@ -0,0 +1,9 @@ +.DiscussionList-update { + .Button--color(@alert-color, @alert-bg); + margin-bottom: 5px; + + .DiscussionPage & { + border-radius: 0; + margin-bottom: 0; + } +} diff --git a/extensions/pusher/locale/en.yml b/extensions/pusher/locale/en.yml new file mode 100644 index 000000000..65131063b --- /dev/null +++ b/extensions/pusher/locale/en.yml @@ -0,0 +1,4 @@ +pusher: + show_updated_discussions: + one: "Show {count} updated discussion" + other: "Show {count} updated discussions" diff --git a/extensions/pusher/src/Extension.php b/extensions/pusher/src/Extension.php new file mode 100644 index 000000000..943431add --- /dev/null +++ b/extensions/pusher/src/Extension.php @@ -0,0 +1,29 @@ +subscribe('Flarum\Pusher\Listeners\AddClientAssets'); + $events->subscribe('Flarum\Pusher\Listeners\PushNewPosts'); + $events->subscribe('Flarum\Pusher\Listeners\AddApiAttributes'); + } + + /** + * Register the service provider. + * + * @return void + */ + public function register() + { + // + } +} diff --git a/extensions/pusher/src/Listeners/AddApiAttributes.php b/extensions/pusher/src/Listeners/AddApiAttributes.php new file mode 100755 index 000000000..e756170ba --- /dev/null +++ b/extensions/pusher/src/Listeners/AddApiAttributes.php @@ -0,0 +1,20 @@ +listen(ApiAttributes::class, [$this, 'addAttributes']); + } + + public function addAttributes(ApiAttributes $event) + { + if ($event->serializer instanceof ForumSerializer) { + $event->attributes['pusherKey'] = app('Flarum\Core\Settings\SettingsRepository')->get('pusher.app_key'); + } + } +} diff --git a/extensions/pusher/src/Listeners/AddClientAssets.php b/extensions/pusher/src/Listeners/AddClientAssets.php new file mode 100644 index 000000000..95ffb8720 --- /dev/null +++ b/extensions/pusher/src/Listeners/AddClientAssets.php @@ -0,0 +1,44 @@ +listen(RegisterLocales::class, [$this, 'addLocale']); + $events->listen(BuildClientView::class, [$this, 'addAssets']); + } + + public function addLocale(RegisterLocales $event) + { + $event->addTranslations('en', __DIR__.'/../../locale/en.yml'); + } + + public function addAssets(BuildClientView $event) + { + $event->forumAssets([ + __DIR__.'/../../js/forum/dist/extension.js', + __DIR__.'/../../less/forum/extension.less' + ]); + + $event->forumBootstrapper('pusher/main'); + + $event->forumTranslations([ + 'pusher.show_updated_discussions' + ]); + + $event->adminAssets([ + __DIR__.'/../../js/admin/dist/extension.js', + __DIR__.'/../../less/admin/extension.less' + ]); + + $event->adminBootstrapper('pusher/main'); + + $event->adminTranslations([ + // 'pusher.hello_world' + ]); + } +} diff --git a/extensions/pusher/src/Listeners/PushNewPosts.php b/extensions/pusher/src/Listeners/PushNewPosts.php new file mode 100644 index 000000000..6f7f6b252 --- /dev/null +++ b/extensions/pusher/src/Listeners/PushNewPosts.php @@ -0,0 +1,47 @@ +settings = $settings; + } + + public function subscribe(Dispatcher $events) + { + $events->listen(PostWasPosted::class, [$this, 'pushNewPost']); + } + + public function pushNewPost(PostWasPosted $event) + { + $guest = new Guest; + $discussion = Discussion::whereVisibleTo($guest)->find($event->post->discussion_id); + + if ($discussion) { + $post = $discussion->postsVisibleTo($guest)->find($event->post->id); + + if ($post) { + $pusher = new Pusher( + $this->settings->get('pusher.app_key'), + $this->settings->get('pusher.app_secret'), + $this->settings->get('pusher.app_id') + ); + + $pusher->trigger('public', 'newPost', [ + 'postId' => $post->id, + 'discussionId' => $discussion->id, + 'tagIds' => $discussion->tags()->lists('id') + ]); + } + } + } +}