summaryrefslogtreecommitdiffstats
path: root/db/item.php
blob: 1ef74061e9a05398ba87d5d29fb40b981453db11 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<?php
/**
 * ownCloud - News
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Alessandro Cosentino <cosenal@gmail.com>
 * @author Bernhard Posselt <dev@bernhard-posselt.com>
 * @copyright Alessandro Cosentino 2012
 * @copyright Bernhard Posselt 2012, 2014
 */

namespace OCA\News\Db;

use \OCP\AppFramework\Db\Entity;


/**
 * @method integer getId()
 * @method void setId(integer $value)
 * @method string getGuid()
 * @method void setGuid(string $value)
 * @method string getGuidHash()
 * @method void setGuidHash(string $value)
 * @method string getUrl()
 * @method string getTitle()
 * @method string getAuthor()
 * @method string getRtl()
 * @method string getFingerprint()
 * @method integer getPubDate()
 * @method void setPubDate(integer $value)
 * @method string getBody()
 * @method string getEnclosureMime()
 * @method void setEnclosureMime(string $value)
 * @method string getEnclosureLink()
 * @method void setEnclosureLink(string $value)
 * @method integer getFeedId()
 * @method void setFeedId(integer $value)
 * @method integer getStatus()
 * @method void setStatus(integer $value)
 * @method void setRtl(boolean $value)
 * @method integer getLastModified()
 * @method void setLastModified(integer $value)
 * @method void setFingerprint(string $value)
 * @method void setSearchIndex(string $value)
 */
class Item extends Entity implements IAPI, \JsonSerializable {

    use EntityJSONSerializer;

    protected $guidHash;
    protected $guid;
    protected $url;
    protected $title;
    protected $author;
    protected $pubDate;
    protected $body;
    protected $enclosureMime;
    protected $enclosureLink;
    protected $feedId;
    protected $status = 0;
    protected $lastModified;
    protected $searchIndex;
    protected $rtl;
    protected $fingerprint;

    public function __construct(){
        $this->addType('pubDate', 'integer');
        $this->addType('feedId', 'integer');
        $this->addType('status', 'integer');
        $this->addType('lastModified', 'integer');
        $this->addType('rtl', 'boolean');
    }


    public function setRead() {
        $this->markFieldUpdated('status');
        $this->status &= ~StatusFlag::UNREAD;
    }

    public function isRead() {
        return !(($this->status & StatusFlag::UNREAD) === StatusFlag::UNREAD);
    }

    public function setUnread() {
        $this->markFieldUpdated('status');
        $this->status |= StatusFlag::UNREAD;
    }

    public function isUnread() {
        return !$this->isRead();
    }

    public function setStarred() {
        $this->markFieldUpdated('status');
        $this->status |= StatusFlag::STARRED;
    }

    public function isStarred() {
        return ($this->status & StatusFlag::STARRED) === StatusFlag::STARRED;
    }

    public function setUnstarred() {
        $this->markFieldUpdated('status');
        $this->status &= ~StatusFlag::STARRED;
    }

    public function isUnstarred() {
        return !$this->isStarred();
    }

    /**
     * Turns entitie attributes into an array
     */
    public function jsonSerialize() {
        return [
            'id' => $this->getId(),
            'guid' => $this->getGuid(),
            'guidHash' => $this->getGuidHash(),
            'url' => $this->getUrl(),
            'title' => $this->getTitle(),
            'author' => $this->getAuthor(),
            'pubDate' => $this->getPubDate(),
            'body' => $this->getBody(),
            'enclosureMime' => $this->getEnclosureMime(),
            'enclosureLink' => $this->getEnclosureLink(),
            'feedId' => $this->getFeedId(),
            'unread' => $this->isUnread(),
            'starred' => $this->isStarred(),
            'lastModified' => $this->getLastModified(),
            'rtl' => $this->getRtl(),
            'intro' => $this->getIntro(),
            'fingerprint' => $this->getFingerprint()
        ];
    }

    public function toAPI() {
        return [
            'id' => $this->getId(),
            'guid' => $this->getGuid(),
            'guidHash' => $this->getGuidHash(),
            'url' => $this->getUrl(),
            'title' => $this->getTitle(),
            'author' => $this->getAuthor(),
            'pubDate' => $this->getPubDate(),
            'body' => $this->getBody(),
            'enclosureMime' => $this->getEnclosureMime(),
            'enclosureLink' => $this->getEnclosureLink(),
            'feedId' => $this->getFeedId(),
            'unread' => $this->isUnread(),
            'starred' => $this->isStarred(),
            'lastModified' => $this->getLastModified(),
            'rtl' => $this->getRtl(),
            'fingerprint' => $this->getFingerprint()
        ];
    }


    public function toExport($feeds) {
        return [
            'guid' => $this->getGuid(),
            'url' => $this->getUrl(),
            'title' => $this->getTitle(),
            'author' => $this->getAuthor(),
            'pubDate' => $this->getPubDate(),
            'body' => $this->getBody(),
            'enclosureMime' => $this->getEnclosureMime(),
            'enclosureLink' => $this->getEnclosureLink(),
            'unread' => $this->isUnread(),
            'starred' => $this->isStarred(),
            'feedLink' => $feeds['feed'. $this->getFeedId()]->getLink(),
            'rtl' => $this->getRtl()
        ];
    }


    public function getIntro() {
        return strip_tags($this->getBody());
    }

    public static function fromImport($import) {
        $item = new static();
        $item->setGuid($import['guid']);
        $item->setGuidHash($import['guid']);
        $item->setUrl($import['url']);
        $item->setTitle($import['title']);
        $item->setAuthor($import['author']);
        $item->setPubDate($import['pubDate']);
        $item->setBody($import['body']);
        $item->setEnclosureMime($import['enclosureMime']);
        $item->setEnclosureLink($import['enclosureLink']);
        $item->setRtl($import['rtl']);
        if($import['unread']) {
            $item->setUnread();
        } else {
            $item->setRead();
        }
        if($import['starred']) {
            $item->setStarred();
        } else {
            $item->setUnstarred();
        }

        return $item;
    }


    public function setAuthor($name) {
        parent::setAuthor(strip_tags($name));
    }


    public function setTitle($title) {
        parent::setTitle(strip_tags($title));
    }

    public function generateSearchIndex() {
        $this->setSearchIndex(
            mb_strtolower(
                html_entity_decode(strip_tags($this->getBody())) .
                html_entity_decode($this->getAuthor()) .
                html_entity_decode($this->getTitle()) .
                $this->getUrl(),
                'UTF-8'
            )
        );
        $this->setFingerprint($this->computeFingerprint());
    }

    private function computeFingerprint() {
        return md5($this->getTitle() . $this->getUrl() . $this->getBody() .
                   $this->getEnclosureLink());
    }

    public function setUrl($url) {
        $url = trim($url);
        if(strpos($url, 'http') === 0 || strpos($url, 'magnet') === 0) {
            parent::setUrl($url);
        }
    }


    public function setBody($body) {
        // FIXME: this should not happen if the target="_blank" is already
        // on the link
        parent::setBody(str_replace(
            '<a', '<a target="_blank" rel="noreferrer"', $body
        ));
    }

}