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
| <?php
/**
* api: freshcode
* title: json feeds
* description: exchange protocol and per-project feeds
* version: 1.1
* license: CC-BY-SA
* depends: php:json, feeder
*
* Generates /xfer stream and per-/project release feeds.
* Returns JSON (interchange format) and RSS or Atom feeds.
*
* The URL schemes:
* http://freshcode.club/feed/projectname (.json optional)
* http://freshcode.club/feed/projectname.rss
* http://freshcode.club/feed/projectname.atom
* For the complete site update list:
* http://freshcode.club/feed/xfer (.json/.atom/.rss)
*
* No Content-Negotiation here, as nobody is even bothering
* anymore. The .htaccess dispatching adds the ?ext=rss if an
* extension (.json / .atom / .rss) was appended.
*
*
* JSON FORMAT
*
* Is still susceptible to changes. Currently freshcode.club
* seems the only FM-reimplementation. But obviously the data
* format should converge to facilitate proper synchronization.
*
* /feed/xfer also doesn't provide the raw DB contents. OpenID
* handles are stripped, and personally identifyable infos
* dropped (e.g. gravatar email).
* Otherwise it's similar to the internal database structure.
*
*/
/**
* group and rename internal columns into feed structure
*
*/
#-- general project description
function feed_project($row) {
return array(
"name" => $row["name"],
"title" => $row["title"],
"summary" => $row["summary"],
"description" => $row["description"],
"homepage" => $row["homepage"],
"license" => $row["license"],
"tags" => $row["tags"],
"image" => $row["image"],
"submitter" => $row["submitter"],
"urls" => p_key_value($row["urls"], CASE_LOWER),
);
}
#-- version/release blocks
function feed_release($row) {
return array(
"version" => $row["version"],
"state" => $row["state"],
"scope" => $row["scope"],
"changes" => $row["changes"],
"download" => versioned_url($row["download"], $row["version"]),
"published" => gmdate(DateTime::ISO8601, $row["t_published"]),
);
}
#-- exchange data
function feed_xfer($row) {
return array(
"hidden" => $row["hidden"],
"changed" => gmdate(DateTime::ISO8601, $row["t_published"]),
"autoupdate_module" => $row["autoupdate_module"],
"autoupdate_url" => $row["autoupdate_url"],
"autoupdate_regex" => $row["autoupdate_regex"],
// following fields will not be transferred for privacy reasons
# "submitter_openid" => $row["submitter_openid"],
# "lock" => $row["submitter_lock"],
);
}
#-- something was requested
if ($name = $_GET->proj_name["name"]) {
list($name, $ext, ) = explode(".", "$name.json");
$feed = array(
"\$feed-origin" => "http://freshcode.club/",
"\$feed-license" => "CC-BY-SA 3.0",
);
#-- exchange data
if ($name == "xfer") {
$feed["releases"] = array();
$r = db("
SELECT *
FROM release
WHERE NOT deleted
AND NOT hidden
GROUP BY name, t_published
ORDER BY t_published DESC, t_changed DESC
LIMIT ?
OFFSET ?",
$_GET->int->default…100->range…1…15000["num"],
$_GET->int->default…0["offset"]
);
$i = $f = 0;
# error_reporting(E_ALL);
# set_error_handler("var_dump");
foreach ($r as $row) {
$i++;
if (json_encode($row)) {
$feed["releases"][] = feed_project($row) + feed_release($row) + feed_xfer($row);
} else { $f++; }
}
header("X-Count: $i");
header("X-Invalid-Encoding: $f");
}
#-- per project
else {
$r = db("SELECT * FROM release_versions WHERE name=? LIMIT 10", $name);
while ( $row = $r->fetch() ) {
// project description
isset($feed["releases"]) or $feed += feed_project($row) + array("releases" => array());
// versions
$feed["releases"][] = feed_release($row);
}
}
#-- Output JSON
if ($ext == "json") {
header("Content-Type: json/vnd.freshcode.club; charset=UTF-8");
exit(json_encode($feed, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES));
}
#-- Else convert into RSS or Atom
else {
/**
* It's obviously super long-winded to restructure the JSON xfer
* or per-project data into RSS/Atom snippets here afterwards.
*
* @todo: restructure
*
*/
$f = new Feeder();
$f->channel()->setfromarray(array(
"title" => "$name",
"description" => "Open Source project updates",
"author" => "freshcode.club",
"license" => $feed["\$feed-license"],
"icon" => "http://freshcode.club/img/changes.png",
"logo" => "http://freshcode.club/logo.png",
"skipHours" => array_diff(range(0, 23), [0,4,8,12,16,20]),
));
if (!empty($feed["releases"]))
foreach ($feed["releases"] as $i=>$row) {
$f->entry($i, new FeedEntry(@array(
"title" => ($row["title"] ?: $feed["title"]) . " $row[version]",
"published" => $row["published"],
"author" => $row["submitter"] ?: $feed["submitter"],
"content" => substr($row["description"], 0, 200) . "…\n– Changes: " . substr($row["changes"], 0, 300),
"permalink" => $row["homepage"] ?: $feed["homepage"],
)));
}
#-- Output
header(sprintf("Cache-Control: max-age=%s", 3 * 90000));
header(sprintf("Expires: %s", gmdate(DATE_COOKIE, time() + 3 * 90000)));
$o = ($ext == "atom") ? new AtomFeed() : new Rss20Feed();
$o->output($f);
}
}
#-- else print an info page
else {
include("template/header.php");
?>
<section id=main class=container-width>
<h4>Feeds</h4>
<p>
You can get any projects <b>releases.json</b> feed using
<ul>
<li> <tt>http://freshcode.club/feed/<em>projectname</em><var style="color: #ccc">.json</var></tt>
</ul>
Alternatively as RSS/Atom feed
<ul>
<li> <tt>http://freshcode.club/feed/<em>projectname</em>.rss</tt>
<li> <tt>http://freshcode.club/feed/<em>projectname</em>.atom</tt>
</ul>
</p>
<p>
To get all project updates instead use
<ul>
<li> <tt>http://freshcode.club/feed/<b>xfer</b><var style="color: #ccc">.json</var></tt>
<li> <tt>http://freshcode.club/projects.rss</tt> or <tt>/?format=rss</tt>
<li> <tt>http://freshcode.club/projects.atom</tt> or <tt>/?format=atom</tt>
</ul>
</p>
<p>
JSON feeds are using a post-1.0 MIME type of <em>json/vnd.freshcode.club</em> for now.
</p>
</section>
<?php
include("template/bottom.php");
}
|