summaryrefslogtreecommitdiff
path: root/formats/AtomFormat.php
blob: 1159a616c7487514011f0cbefc36207b3732756b (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
<?php
/**
 * AtomFormat - RFC 4287: The Atom Syndication Format
 * https://tools.ietf.org/html/rfc4287
 *
 * Validator:
 * https://validator.w3.org/feed/
 */
class AtomFormat extends FormatAbstract{
	const LIMIT_TITLE = 140;

	public function stringify(){
		$urlPrefix = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https://' : 'http://';
		$urlHost = (isset($_SERVER['HTTP_HOST'])) ? $_SERVER['HTTP_HOST'] : '';
		$urlPath = (isset($_SERVER['PATH_INFO'])) ? $_SERVER['PATH_INFO'] : '';
		$urlRequest = (isset($_SERVER['REQUEST_URI'])) ? $_SERVER['REQUEST_URI'] : '';

		$feedUrl = $this->xml_encode($urlPrefix . $urlHost . $urlRequest);

		$extraInfos = $this->getExtraInfos();
		$title = $this->xml_encode($extraInfos['name']);
		$uri = !empty($extraInfos['uri']) ? $extraInfos['uri'] : REPOSITORY;

		// since we can't guarantee that all items have an author,
		// a global feed author is mandatory
		$feedAuthor = 'RSS-Bridge';

		$uriparts = parse_url($uri);
		if(!empty($extraInfos['icon'])) {
			$icon = $extraInfos['icon'];
		} else {
			$icon = $this->xml_encode($uriparts['scheme'] . '://' . $uriparts['host'] . '/favicon.ico');
		}

		$uri = $this->xml_encode($uri);

		$entries = '';
		foreach($this->getItems() as $item) {
			$entryTimestamp = $item->getTimestamp();
			$entryTitle = $item->getTitle();
			$entryContent = $item->getContent();
			$entryUri = $item->getURI();
			$entryID = '';

			if (!empty($item->getUid()))
				$entryID = 'urn:sha1:' . $item->getUid();

			if (empty($entryID)) // Fallback to provided URI
				$entryID = $this->xml_encode($entryUri);

			if (empty($entryID)) // Fallback to title and content
				$entryID = 'urn:sha1:' . hash('sha1', $entryTitle . $entryContent);

			if (empty($entryTimestamp))
				$entryTimestamp = $this->lastModified;

			if (empty($entryTitle)) {
				$entryTitle = str_replace("\n", ' ', strip_tags($entryContent));
				if (strlen($entryTitle) > self::LIMIT_TITLE) {
					$wrapPos = strpos(wordwrap($entryTitle, self::LIMIT_TITLE), "\n");
					$entryTitle = substr($entryTitle, 0, $wrapPos) . '...';
				}
			}

			if (empty($entryContent))
				$entryContent = $entryTitle;

			$entryAuthor = $this->xml_encode($item->getAuthor());
			$entryTitle = $this->xml_encode($entryTitle);
			$entryUri = $this->xml_encode($entryUri);
			$entryTimestamp = $this->xml_encode(gmdate(DATE_ATOM, $entryTimestamp));
			$entryContent = $this->xml_encode($this->sanitizeHtml($entryContent));

			$entryEnclosures = '';
			foreach($item->getEnclosures() as $enclosure) {
				$entryEnclosures .= '<link rel="enclosure" href="'
				. $this->xml_encode($enclosure)
				. '" type="' . getMimeType($enclosure) . '" />'
				. PHP_EOL;
			}

			$entryCategories = '';
			foreach($item->getCategories() as $category) {
				$entryCategories .= '<category term="'
				. $this->xml_encode($category)
				. '"/>'
				. PHP_EOL;
			}

			$entryLinkAlternate = '';
			if (!empty($entryUri)) {
				$entryLinkAlternate = '<link rel="alternate" type="text/html" href="'
				. $entryUri
				. '"/>';
			}

			if (!empty($entryAuthor)) {
				$entryAuthor = '<author><name>'
				. $entryAuthor
				. '</name></author>';
			}

			$entries .= <<<EOD

	<entry>
		<title type="html">{$entryTitle}</title>
		<published>{$entryTimestamp}</published>
		<updated>{$entryTimestamp}</updated>
		<id>{$entryID}</id>
		{$entryLinkAlternate}
		{$entryAuthor}
		<content type="html">{$entryContent}</content>
		{$entryEnclosures}
		{$entryCategories}
	</entry>

EOD;
		}

		$feedTimestamp = gmdate(DATE_ATOM, $this->lastModified);
		$charset = $this->getCharset();

		/* Data are prepared, now let's begin the "MAGIE !!!" */
		$toReturn = <<<EOD
<?xml version="1.0" encoding="{$charset}"?>
<feed xmlns="http://www.w3.org/2005/Atom">

	<title type="text">{$title}</title>
	<id>{$feedUrl}</id>
	<icon>{$icon}</icon>
	<logo>{$icon}</logo>
	<updated>{$feedTimestamp}</updated>
	<author>
		<name>{$feedAuthor}</name>
	</author>
	<link rel="alternate" type="text/html" href="{$uri}" />
	<link rel="self" type="application/atom+xml" href="{$feedUrl}" />
{$entries}
</feed>
EOD;

		// Remove invalid characters
		ini_set('mbstring.substitute_character', 'none');
		$toReturn = mb_convert_encoding($toReturn, $this->getCharset(), 'UTF-8');
		return $toReturn;
	}

	public function display(){
		$this
			->setContentType('application/atom+xml; charset=' . $this->getCharset())
			->callContentType();

		return parent::display();
	}

	private function xml_encode($text){
		return htmlspecialchars($text, ENT_XML1);
	}
}