Adding <meta> descriptions and Laravel's slug generator function with transliteration

js/admin/dist/app.js

@@ -16913,10 +16913,10 @@ System.register('flarum/app', ['flarum/App', 'flarum/initializers/store', 'flaru
 });;
 'use strict';
 
-System.register('flarum/App', ['flarum/utils/ItemList', 'flarum/components/Alert', 'flarum/components/Button', 'flarum/components/RequestErrorModal', 'flarum/components/ConfirmPasswordModal', 'flarum/Translator', 'flarum/utils/extract', 'flarum/utils/patchMithril', 'flarum/utils/RequestError', 'flarum/extend'], function (_export, _context) {
+System.register('flarum/App', ['flarum/utils/ItemList', 'flarum/components/Alert', 'flarum/components/Button', 'flarum/components/RequestErrorModal', 'flarum/components/ConfirmPasswordModal', 'flarum/Translator', 'flarum/utils/extract', 'flarum/utils/patchMithril', 'flarum/utils/RequestError', 'flarum/extend', 'flarum/utils/string'], function (_export, _context) {
   "use strict";
 
-  var ItemList, Alert, Button, RequestErrorModal, ConfirmPasswordModal, Translator, extract, patchMithril, RequestError, extend, App;
+  var ItemList, Alert, Button, RequestErrorModal, ConfirmPasswordModal, Translator, extract, patchMithril, RequestError, extend, getPlainContent, truncate, App;
   return {
     setters: [function (_flarumUtilsItemList) {
       ItemList = _flarumUtilsItemList.default;
@@ -16938,6 +16938,9 @@ System.register('flarum/App', ['flarum/utils/ItemList', 'flarum/components/Alert
       RequestError = _flarumUtilsRequestError.default;
     }, function (_flarumExtend) {
       extend = _flarumExtend.extend;
+    }, function (_flarumUtilsString) {
+      getPlainContent = _flarumUtilsString.getPlainContent;
+      truncate = _flarumUtilsString.truncate;
     }],
     execute: function () {
       App = function () {
@@ -17029,6 +17032,8 @@ System.register('flarum/App', ['flarum/utils/ItemList', 'flarum/components/Alert
 
           this.title = '';
           this.titleCount = 0;
+
+          this.description = '';
         }
 
         /**
@@ -17080,6 +17085,18 @@ System.register('flarum/App', ['flarum/utils/ItemList', 'flarum/components/Alert
           value: function updateTitle() {
             document.title = (this.titleCount ? '(' + this.titleCount + ') ' : '') + (this.title ? this.title + ' - ' : '') + this.forum.attribute('title');
           }
+        }, {
+          key: 'setDescription',
+          value: function setDescription(description) {
+            description = truncate(getPlainContent(description), 300, 0);
+            this.description = description;
+            this.updateDescription();
+          }
+        }, {
+          key: 'updateDescription',
+          value: function updateDescription() {
+            document.head.querySelector('meta[name=description]').content = this.description ? this.description : this.forum.attribute('description');
+          }
         }, {
           key: 'request',
           value: function request(originalOptions) {
@@ -22375,6 +22392,7 @@ System.register('flarum/models/Discussion', ['flarum/Model', 'flarum/utils/compu
       babelHelpers.extends(Discussion.prototype, {
         title: Model.attribute('title'),
         slug: Model.attribute('slug'),
+        description: Model.attribute('description'),
 
         startTime: Model.attribute('startTime', Model.transformDate),
         startUser: Model.hasOne('startUser'),

js/forum/dist/app.js

@@ -18246,10 +18246,10 @@ System.register('flarum/app', ['flarum/ForumApp', 'flarum/initializers/store', '
 });;
 'use strict';
 
-System.register('flarum/App', ['flarum/utils/ItemList', 'flarum/components/Alert', 'flarum/components/Button', 'flarum/components/RequestErrorModal', 'flarum/components/ConfirmPasswordModal', 'flarum/Translator', 'flarum/utils/extract', 'flarum/utils/patchMithril', 'flarum/utils/RequestError', 'flarum/extend'], function (_export, _context) {
+System.register('flarum/App', ['flarum/utils/ItemList', 'flarum/components/Alert', 'flarum/components/Button', 'flarum/components/RequestErrorModal', 'flarum/components/ConfirmPasswordModal', 'flarum/Translator', 'flarum/utils/extract', 'flarum/utils/patchMithril', 'flarum/utils/RequestError', 'flarum/extend', 'flarum/utils/string'], function (_export, _context) {
   "use strict";
 
-  var ItemList, Alert, Button, RequestErrorModal, ConfirmPasswordModal, Translator, extract, patchMithril, RequestError, extend, App;
+  var ItemList, Alert, Button, RequestErrorModal, ConfirmPasswordModal, Translator, extract, patchMithril, RequestError, extend, getPlainContent, truncate, App;
   return {
     setters: [function (_flarumUtilsItemList) {
       ItemList = _flarumUtilsItemList.default;
@@ -18271,6 +18271,9 @@ System.register('flarum/App', ['flarum/utils/ItemList', 'flarum/components/Alert
       RequestError = _flarumUtilsRequestError.default;
     }, function (_flarumExtend) {
       extend = _flarumExtend.extend;
+    }, function (_flarumUtilsString) {
+      getPlainContent = _flarumUtilsString.getPlainContent;
+      truncate = _flarumUtilsString.truncate;
     }],
     execute: function () {
       App = function () {
@@ -18362,6 +18365,8 @@ System.register('flarum/App', ['flarum/utils/ItemList', 'flarum/components/Alert
 
           this.title = '';
           this.titleCount = 0;
+
+          this.description = '';
         }
 
         /**
@@ -18413,6 +18418,18 @@ System.register('flarum/App', ['flarum/utils/ItemList', 'flarum/components/Alert
           value: function updateTitle() {
             document.title = (this.titleCount ? '(' + this.titleCount + ') ' : '') + (this.title ? this.title + ' - ' : '') + this.forum.attribute('title');
           }
+        }, {
+          key: 'setDescription',
+          value: function setDescription(description) {
+            description = truncate(getPlainContent(description), 300, 0);
+            this.description = description;
+            this.updateDescription();
+          }
+        }, {
+          key: 'updateDescription',
+          value: function updateDescription() {
+            document.head.querySelector('meta[name=description]').content = this.description ? this.description : this.forum.attribute('description');
+          }
         }, {
           key: 'request',
           value: function request(originalOptions) {
@@ -21161,6 +21178,9 @@ System.register('flarum/components/DiscussionPage', ['flarum/components/Page', '
             app.setTitle(discussion.title());
             app.setTitleCount(0);
 
+            var description = this.discussion.description() || this.discussion.startPost.content();
+            app.setDescription(description);
+
             // When the API responds with a discussion, it will also include a number of
             // posts. Some of these posts are included because they are on the first
             // page of posts we want to display (determined by the `near` parameter) –
@@ -22649,6 +22669,7 @@ System.register('flarum/components/IndexPage', ['flarum/extend', 'flarum/compone
 
             app.setTitle('');
             app.setTitleCount(0);
+            app.setDescription('');
 
             // Work out the difference between the height of this hero and that of the
             // previous hero. Maintain the same scroll position relative to the bottom
@@ -24950,7 +24971,7 @@ System.register('flarum/components/PostStream', ['flarum/Component', 'flarum/uti
         }, {
           key: 'update',
           value: function update() {
-            if (!this.viewingEnd) return;
+            if (!this.viewingEnd) return m.deferred().resolve().promise;
 
             this.visibleEnd = this.count();
 
@@ -27164,6 +27185,7 @@ System.register('flarum/components/SettingsPage', ['flarum/components/UserPage',
 
             this.show(app.session.user);
             app.setTitle(app.translator.trans('core.forum.settings.title'));
+            app.setDescription('');
           }
         }, {
           key: 'content',
@@ -27997,6 +28019,7 @@ System.register('flarum/components/UserPage', ['flarum/components/Page', 'flarum
             this.user = user;
 
             app.setTitle(user.displayName());
+            app.setDescription('');
 
             m.redraw();
           }
@@ -29427,6 +29450,7 @@ System.register('flarum/models/Discussion', ['flarum/Model', 'flarum/utils/compu
       babelHelpers.extends(Discussion.prototype, {
         title: Model.attribute('title'),
         slug: Model.attribute('slug'),
+        description: Model.attribute('description'),
 
         startTime: Model.attribute('startTime', Model.transformDate),
         startUser: Model.hasOne('startUser'),

js/forum/src/components/DiscussionPage.js

@@ -163,6 +163,9 @@ export default class DiscussionPage extends Page {
     app.setTitle(discussion.title());
     app.setTitleCount(0);
 
+    let description = this.discussion.description() || this.discussion.startPost.content();
+    app.setDescription(description);
+
     // When the API responds with a discussion, it will also include a number of
     // posts. Some of these posts are included because they are on the first
     // page of posts we want to display (determined by the `near` parameter) –

js/forum/src/components/IndexPage.js

@@ -95,6 +95,7 @@ export default class IndexPage extends Page {
 
     app.setTitle('');
     app.setTitleCount(0);
+    app.setDescription('');
 
     // Work out the difference between the height of this hero and that of the
     // previous hero. Maintain the same scroll position relative to the bottom

js/forum/src/components/SettingsPage.js

@@ -18,6 +18,7 @@ export default class SettingsPage extends UserPage {
 
     this.show(app.session.user);
     app.setTitle(app.translator.trans('core.forum.settings.title'));
+    app.setDescription('');
   }
 
   content() {

js/forum/src/components/UserPage.js

@@ -73,6 +73,7 @@ export default class UserPage extends Page {
     this.user = user;
 
     app.setTitle(user.displayName());
+    app.setDescription('');
 
     m.redraw();
   }

js/lib/App.js

@@ -8,6 +8,7 @@ import extract from 'flarum/utils/extract';
 import patchMithril from 'flarum/utils/patchMithril';
 import RequestError from 'flarum/utils/RequestError';
 import { extend } from 'flarum/extend';
+import { getPlainContent, truncate } from 'flarum/utils/string';
 
 /**
  * The `App` class provides a container for an application, as well as various
@@ -100,6 +101,8 @@ export default class App {
 
     this.title = '';
     this.titleCount = 0;
+
+    this.description = '';
   }
 
   /**
@@ -159,6 +162,23 @@ export default class App {
       this.forum.attribute('title');
   }
 
+  /**
+   * Set the <meta name="description"> of the page.
+   *
+   * @param {String} description
+   * @public
+   */
+  setDescription(description) {
+    description = truncate(getPlainContent(description), 300, 0);
+    this.description = description;
+    this.updateDescription();
+  }
+
+  updateDescription() {
+    document.head.querySelector('meta[name=description]').content =
+      (this.description ? this.description : this.forum.attribute('description'));
+  }
+
   /**
    * Make an AJAX request, handling any low-level errors that may occur.
    *

js/lib/models/Discussion.js

@@ -8,6 +8,7 @@ export default class Discussion extends Model {}
 Object.assign(Discussion.prototype, {
   title: Model.attribute('title'),
   slug: Model.attribute('slug'),
+  description: Model.attribute('description'),
 
   startTime: Model.attribute('startTime', Model.transformDate),
   startUser: Model.hasOne('startUser'),

migrations/2016_02_04_095452_add_slug_to_discussions.php

@@ -9,21 +9,27 @@
  * file that was distributed with this source code.
  */
 
-use Flarum\Util\Str;
+use Flarum\Foundation\Application;
+use Flarum\Settings\SettingsRepositoryInterface;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Schema\Builder;
+use Illuminate\Support\Str;
 
 return [
     'up' => function (Builder $schema) {
         $schema->table('discussions', function (Blueprint $table) {
             $table->string('slug');
         });
 
+        $app = Application::getInstance();
+        $settings = $app->make(SettingsRepositoryInterface::class);
+        $locale = $settings->get('default_locale') ?? 'en';
+
         // Store slugs for existing discussions
-        $schema->getConnection()->table('discussions')->chunkById(100, function ($discussions) use ($schema) {
+        $schema->getConnection()->table('discussions')->chunkById(100, function ($discussions) use ($schema, $locale) {
             foreach ($discussions as $discussion) {
                 $schema->getConnection()->table('discussions')->where('id', $discussion->id)->update([
-                    'slug' => Str::slug($discussion->title)
+                    'slug' => Str::slug($discussion->title, '-', $locale)
                 ]);
             }
         });

migrations/2018_03_18_194500_add_description_to_discussions.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * (c) Toby Zerner <toby.zerner@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Schema\Builder;
+
+return [
+    'up' => function (Builder $schema) {
+        $schema->table('discussions', function (Blueprint $table) {
+            $table->string('description')->after('title');
+        });
+    },
+
+    'down' => function (Builder $schema) {
+        $schema->table('discussions', function (Blueprint $table) {
+            $table->dropColumn('description');
+        });
+    }
+];

src/Api/Serializer/BasicDiscussionSerializer.php

@@ -37,7 +37,8 @@ protected function getDefaultAttributes($discussion)
 
         return [
             'title' => $discussion->title,
-            'slug'  => $discussion->slug,
+            'description' => $discussion->description,
+            'slug'  => $discussion->slug
         ];
     }
 

src/Discussion/Discussion.php

@@ -19,17 +19,20 @@
 use Flarum\Discussion\Event\Restored;
 use Flarum\Discussion\Event\Started;
 use Flarum\Event\GetModelIsPrivate;
+use Flarum\Foundation\Application;
 use Flarum\Foundation\EventGeneratorTrait;
 use Flarum\Post\Event\Deleted as PostDeleted;
 use Flarum\Post\MergeableInterface;
 use Flarum\Post\Post;
+use Flarum\Settings\SettingsRepositoryInterface;
 use Flarum\User\User;
-use Flarum\Util\Str;
+use Illuminate\Support\Str;
 
 /**
  * @property int $id
  * @property string $title
  * @property string $slug
+ * @property string $description
  * @property int $comments_count
  * @property int $participants_count
  * @property int $number_index
@@ -461,6 +464,24 @@ public static function setStateUser(User $user)
     protected function setTitleAttribute($title)
     {
         $this->attributes['title'] = $title;
-        $this->slug = Str::slug($title);
+        $app = Application::getInstance();
+        $settings = $app->make(SettingsRepositoryInterface::class);
+        $locale = $settings->get('default_locale') ?? 'en';
+        $this->slug = Str::slug($title, '-', $locale);
+    }
+
+    /**
+     * Get the description.
+     *
+     * Returns the stored description (if any) or generates one based on startPost´s content.
+     *
+     * @param string $description
+     * @return string
+     */
+    protected function getDescriptionAttribute($description)
+    {
+        $description = ($description == null) ? $this->startPost->content : $description;
+
+        return $description;
     }
 }

src/Forum/Controller/DiscussionController.php

@@ -86,6 +86,7 @@ protected function getView(Request $request)
         }
 
         $view->title = $document->data->attributes->title;
+        $view->description = $document->data->attributes->description;
         $view->document = $document;
         $view->content = app('view')->make('flarum.forum::frontend.content.discussion', compact('document', 'page', 'getResource', 'posts', 'url'));