xref: /template/strap/action/metatwitter.php (revision 32b85071e019dd3646a67c17fac4051338e495eb) 
1<?php
2
3use ComboStrap\Image;
4use ComboStrap\LogUtility;
5use ComboStrap\MetadataUtility;
6use ComboStrap\PluginUtility;
7use ComboStrap\Page;
8use ComboStrap\Site;
9use ComboStrap\StringUtility;
10
11if (!defined('DOKU_INC')) die();
12
13require_once(__DIR__ . '/../class/Site.php');
14
15/**
16 *
17 * For the canonical meta, see {@link action_plugin_combo_metacanonical}
18 * https://github.com/twbs/bootstrap/blob/v4-dev/site/layouts/partials/social.html
19 *
20 * TODO: https://developer.twitter.com/en/docs/twitter-for-websites/embedded-tweets/overview
21 */
22class action_plugin_combo_metatwitter extends DokuWiki_Action_Plugin
23{
24
25
26    /**
27     * The handle name
28     */
29    const CONF_TWITTER_SITE_HANDLE = "twitterSiteHandle";
30    /**
31     * The handle id
32     */
33    const CONF_TWITTER_SITE_ID = "twitterSiteId";
34    /**
35     * The image
36     */
37    const CONF_DEFAULT_TWITTER_IMAGE = "defaultTwitterImage";
38
39    /**
40     * Don't track
41     */
42    const CONF_TWITTER_DONT_NOT_TRACK = self::META_DNT;
43    const CONF_DONT_NOT_TRACK = self::META_DNT;
44    const CONF_ON = "on";
45    const CONF_OFF = "off";
46
47    /**
48     * The creation ie (combostrap)
49     */
50    const COMBO_STRAP_TWITTER_HANDLE = "@combostrapweb";
51    const COMBO_STRAP_TWITTER_ID = "1283330969332842497";
52    const CANONICAL = "twitter";
53
54    const META_CARD = "twitter:card";
55    const DEFAULT_IMAGE = ":apple-touch-icon.png";
56    const META_DESCRIPTION = "twitter:description";
57    const META_IMAGE = "twitter:image";
58    const META_TITLE = "twitter:title";
59    const META_CREATOR = "twitter:creator";
60    const META_CREATOR_ID = "twitter:creator:id";
61    const META_SITE = "twitter:site";
62    const META_SITE_ID = "twitter:site:id";
63    const META_IMAGE_ALT = "twitter:image:alt";
64    const META_DNT = "twitter:dnt";
65    const META_WIDGET_CSP = "twitter:widgets:csp";
66    const META_WIDGETS_THEME = "twitter:widgets:theme";
67    const META_WIDGETS_BORDER_COLOR = "twitter:widgets:border-color";
68
69
70    function __construct()
71    {
72        // enable direct access to language strings
73        // ie $this->lang
74        $this->setupLocale();
75    }
76
77    public function register(Doku_Event_Handler $controller)
78    {
79        $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'metaTwitterProcessing', array());
80    }
81
82    /**
83     *
84     * @param $event
85     */
86    function metaTwitterProcessing($event)
87    {
88
89        global $ID;
90        if (empty($ID)) {
91            // $ID is null for media
92            return;
93        }
94
95
96        $page = new Page($ID);
97
98        /**
99         * No social for bars
100         */
101        if ($page->isBar()) {
102            return;
103        }
104
105
106        // https://datacadamia.com/marketing/twitter#html_meta
107        // https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/markup
108        // https://cards-dev.twitter.com/validator
109
110        $description = $page->getDescriptionOrElseDokuWiki();
111        $twitterMeta = array(
112            self::META_CARD => "summary",
113            self::META_TITLE => StringUtility::truncateString($page->getTitleNotEmpty(), 70),
114            self::META_DESCRIPTION => StringUtility::truncateString($description, 200),
115            self::META_CREATOR => self::COMBO_STRAP_TWITTER_HANDLE,
116            self::META_CREATOR_ID => self::COMBO_STRAP_TWITTER_ID
117        );
118
119
120        /**
121         * Twitter site
122         */
123        $siteTwitterHandle = PluginUtility::getConfValue(self::CONF_TWITTER_SITE_HANDLE);
124        $siteTwitterId = PluginUtility::getConfValue(self::CONF_TWITTER_SITE_ID);
125        if (!empty($siteTwitterHandle)) {
126            $twitterMeta[self::META_SITE] = $siteTwitterHandle;
127
128            // Identify the Twitter profile of the page that populates the via property
129            // https://developer.twitter.com/en/docs/twitter-for-websites/webpage-properties
130            $name = str_replace("@","",$siteTwitterHandle);
131            $event->data['link'][] = array("rel" => "me", "href" => "https://twitter.com/$name");
132        }
133        if (!empty($siteTwitterId)) {
134            $twitterMeta[self::META_SITE_ID] = $siteTwitterId;
135        }
136
137        /**
138         * Card image
139         */
140        $twitterImages = $page->getImageSet();
141        if (empty($twitterImages)) {
142            $defaultImageIdConf = cleanID(PluginUtility::getConfValue(self::CONF_DEFAULT_TWITTER_IMAGE));
143            if (!empty($defaultImageIdConf)) {
144                $twitterImage = new Image($defaultImageIdConf);
145                if ($twitterImage->exists()) {
146                    $twitterImages[] = $twitterImage;
147                } else {
148                    if ($defaultImageIdConf != "apple-touch-icon.png") {
149                        LogUtility::msg("The default twitter image ($defaultImageIdConf) does not exist", LogUtility::LVL_MSG_ERROR, self::CANONICAL);
150                    }
151                }
152            }
153
154        }
155        if (!empty($twitterImages)) {
156            foreach ($twitterImages as $twitterImage) {
157                if ($twitterImage->exists()) {
158                    $twitterMeta[self::META_IMAGE] = $twitterImage->getUrl();
159                    if (!empty($twitterImage->getAlt())) {
160                        $twitterMeta[self::META_IMAGE_ALT] = $twitterImage->getAlt();
161                    }
162                    // One image only
163                    break;
164                }
165            }
166        }
167
168        /**
169         * https://developer.twitter.com/en/docs/twitter-for-websites/webpage-properties
170         */
171        // don't track
172        $twitterMeta[self::META_DNT]=PluginUtility::getConfValue(self::CONF_TWITTER_DONT_NOT_TRACK);
173        // turn off csp warning
174        $twitterMeta[self::META_WIDGET_CSP]="on";
175
176        /**
177         * Embedded Tweet Theme
178         */
179
180        $twitterMeta[self::META_WIDGETS_THEME]=PluginUtility::getConfValue(syntax_plugin_combo_blockquote::CONF_TWEET_WIDGETS_THEME);
181        $twitterMeta[self::META_WIDGETS_BORDER_COLOR]=PluginUtility::getConfValue(syntax_plugin_combo_blockquote::CONF_TWEET_WIDGETS_BORDER);
182
183        /**
184         * Add the properties
185         */
186        foreach ($twitterMeta as $key => $content) {
187            $event->data['meta'][] = array("name" => $key, "content" => $content);
188        }
189
190
191
192    }
193
194}
195