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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
;;; newst-reader.el --- Generic RSS reader functions. -*- lexical-binding: t; -*-
;; Copyright (C) 2003-2021 Free Software Foundation, Inc.
;; Author: Ulf Jasper <ulf.jasper@web.de>
;; Filename: newst-reader.el
;; URL: http://www.nongnu.org/newsticker
;; Package: newsticker
;; ======================================================================
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;; ======================================================================
;;; Commentary:
;; See newsticker.el
;; ======================================================================
;;; Code:
(require 'newst-backend)
;; ======================================================================
;;; Customization
;; ======================================================================
(defun newsticker--set-customvar-formatting (symbol value)
"Set newsticker-variable SYMBOL value to VALUE.
Calls all actions which are necessary in order to make the new
value effective."
(if (or (not (boundp symbol))
(equal (symbol-value symbol) value))
(set symbol value)
;; something must have changed
(set symbol value)
(when (fboundp 'newsticker--forget-preformatted)
(newsticker--forget-preformatted))))
;; ======================================================================
;; reader
(defgroup newsticker-reader nil
"Settings for the feed reader."
:group 'newsticker)
(defcustom newsticker-frontend
'newsticker-treeview
"Newsticker frontend for reading news.
This must be one of the functions `newsticker-plainview' or
`newsticker-treeview'."
:type '(choice :tag "Frontend"
(const :tag "Single buffer (plainview)" newsticker-plainview)
(const :tag "Tree view (treeview)" newsticker-treeview))
:group 'newsticker-reader)
;; image related things
(defcustom newsticker-download-logos
t
"If non-nil newsticker downloads logo images of subscribed feeds."
:version "25.1"
:type 'boolean
:group 'newsticker-reader)
(defcustom newsticker-enable-logo-manipulations
t
"If non-nil newsticker manipulates logo images.
This enables the following image properties: heuristic mask for all
logos, and laplace-conversion for images without new items."
:type 'boolean
:group 'newsticker-reader)
(defcustom newsticker-justification
'left
"How to fill item descriptions.
If non-nil newsticker calls `fill-region' to wrap long lines in
item descriptions. However, if an item description contains HTML
text and `newsticker-html-renderer' is non-nil, filling is not
done."
:type '(choice :tag "Justification"
(const :tag "No filling" nil)
(const :tag "Left" left)
(const :tag "Right" right)
(const :tag "Center" center)
(const :tag "Full" full))
:set #'newsticker--set-customvar-formatting
:group 'newsticker-reader)
(defcustom newsticker-use-full-width
t
"Decides whether to use the full window width when filling.
If non-nil newsticker sets `fill-column' so that the whole
window is used when filling. See also `newsticker-justification'."
:type 'boolean
:set #'newsticker--set-customvar-formatting
:group 'newsticker-reader)
(defcustom newsticker-html-renderer
(if (fboundp 'libxml-parse-html-region)
#'shr-render-region)
"Function for rendering HTML contents.
If non-nil, newsticker.el will call this function whenever it
finds HTML-like tags in item descriptions.
Possible functions include `shr-render-region', `w3m-region', `w3-region', and
`newsticker-htmlr-render'.
Newsticker automatically loads the respective package w3m, w3, or
htmlr if this option is set."
:type '(choice :tag "Function"
(const :tag "None" nil)
(const :tag "SHR" shr-render-region)
(const :tag "w3" w3-region)
(const :tag "w3m" w3m-region)
(const :tag "htmlr" newsticker-htmlr-render))
:set #'newsticker--set-customvar-formatting
:group 'newsticker-reader)
(defcustom newsticker-date-format
"(%A, %H:%M)"
"Format for the date part in item and feed lines.
See `format-time-string' for a list of valid specifiers."
:type 'string
:set #'newsticker--set-customvar-formatting
:group 'newsticker-reader)
(defgroup newsticker-faces nil
"Settings for the faces of the feed reader."
:group 'newsticker-reader)
(defface newsticker-feed-face
'((default :weight bold :height 1.2)
(((class color) (background dark)) :foreground "white")
(((class color) (background light)) :foreground "black"))
"Face for news feeds."
:group 'newsticker-faces)
(defface newsticker-extra-face
'((default :slant italic :height 0.8)
(((class color) (background dark)) :foreground "gray50")
(((class color) (background light)) :foreground "gray50"))
"Face for newsticker dates."
:group 'newsticker-faces)
(defface newsticker-enclosure-face
'((default :weight bold)
(((class color) (background dark)) :background "orange")
(((class color) (background light)) :background "orange"))
"Face for enclosed elements."
:group 'newsticker-faces)
;; ======================================================================
;;; Utility functions
;; ======================================================================
(defun newsticker--insert-enclosure (item keymap)
"Insert enclosure element of a news ITEM into the current buffer.
KEYMAP will be applied."
(let ((enclosure (newsticker--enclosure item))
(beg (point)))
(when enclosure
(let ((url (cdr (assoc 'url enclosure)))
(length (string-to-number (or (cdr (assoc 'length enclosure))
"-1")))
(type (cdr (assoc 'type enclosure))))
(cond ((> length 1048576)
(insert (format "Enclosed file (%s, %1.2f MBytes)" type
(/ length 1048576))))
((> length 1024)
(insert (format "Enclosed file (%s, %1.2f KBytes)" type
(/ length 1024))))
((> length 0)
(insert (format "Enclosed file (%s, %1.2f Bytes)" type
length)))
(t
(insert (format "Enclosed file (%s, unknown size)" type))))
(add-text-properties beg (point)
(list 'mouse-face 'highlight
'nt-link url
'help-echo (format
"mouse-2: visit (%s)" url)
'keymap keymap
'nt-face 'enclosure
'nt-type 'desc))
(insert "\n")))))
(defun newsticker--print-extra-elements (item keymap &optional htmlish)
"Insert extra-elements of ITEM in a pretty form into the current buffer.
KEYMAP is applied. If HTMLISH is non-nil then HTML-markup is used
for formatting."
(let ((ignored-elements '(items link title description content
content:encoded encoded
dc:subject subject
dc:date date entry item guid pubDate
published updated
enclosure))
(left-column-width 1))
(if htmlish (insert "<ul>"))
(mapc (lambda (extra-element)
(when (listp extra-element) ;; take care of broken xml
;; data, 2007-05-25
(unless (memq (car extra-element) ignored-elements)
(setq left-column-width (max left-column-width
(length (symbol-name
(car extra-element))))))))
(newsticker--extra item))
(mapc (lambda (extra-element)
(when (listp extra-element) ;; take care of broken xml
;; data, 2007-05-25
(unless (memq (car extra-element) ignored-elements)
(newsticker--do-print-extra-element extra-element
left-column-width
keymap
htmlish))))
(newsticker--extra item))
(if htmlish (insert "</ul>"))))
(defun newsticker--do-print-extra-element (extra-element width keymap htmlish)
"Actually print an EXTRA-ELEMENT using the given WIDTH.
KEYMAP is applied. If HTMLISH is non-nil then HTML-markup is used
for formatting."
(let ((name (symbol-name (car extra-element))))
(if htmlish
(insert (format "<li>%s: " name))
(insert (format "%s: " name))
(insert (make-string (- width (length name)) ? ))))
(let (;;(attributes (cadr extra-element)) ;FIXME!!!!
(contents (cddr extra-element)))
(cond ((listp contents)
(mapc (lambda (i)
(if (and (stringp i)
(string-match "^http://.*" i))
(let ((pos (point)))
(insert i " ") ; avoid self-reference from the
; nt-link thing
(add-text-properties
pos (point)
(list 'mouse-face 'highlight
'nt-link i
'help-echo
(format "mouse-2: visit (%s)" i)
'keymap keymap)))
(insert (format "%s" i))))
contents))
(t
(insert (format "%s" contents))))
(if htmlish
(insert "</li>")
(insert "\n"))))
(defun newsticker--image-read (feed-name-symbol disabled &optional max-height)
"Read the cached image for FEED-NAME-SYMBOL from disk.
If DISABLED is non-nil the image will be converted to a disabled look
\(unless `newsticker-enable-logo-manipulations' is not t).
Optional argument MAX-HEIGHT specifies the maximal image height.
Return the image."
(let ((image-name (concat (newsticker--images-dir)
(symbol-name feed-name-symbol))))
(when (file-exists-p image-name)
(condition-case error-data
(create-image
image-name
(and (fboundp 'imagemagick-types)
(imagemagick-types)
'imagemagick)
nil
:conversion (and newsticker-enable-logo-manipulations
disabled
'disabled)
:mask (and newsticker-enable-logo-manipulations
'heuristic)
:ascent 100
:max-height max-height)
(error
(message "Error: cannot create image for %s: %s"
feed-name-symbol error-data))))))
(defun newsticker--icon-read (feed-name-symbol)
"Read the cached icon for FEED-NAME-SYMBOL from disk.
Return the image."
(catch 'icon
(when (file-exists-p (newsticker--icons-dir))
(dolist (file (directory-files (newsticker--icons-dir) t
(concat (symbol-name feed-name-symbol) "\\..*")))
(condition-case error-data
(throw 'icon (create-image
file (and (fboundp 'imagemagick-types)
(imagemagick-types)
'imagemagick)
nil
:ascent 'center
:max-width 16
:max-height 16))
(error
(message "Error: cannot create icon for %s: %s"
feed-name-symbol error-data)))))
;; Fallback: default icon.
(find-image '((:type png :file "newsticker/rss-feed.png" :ascent center)))))
;; the functions we need for retrieval and display
;;;###autoload
(defun newsticker-show-news ()
"Start reading news. You may want to bind this to a key."
(interactive)
(newsticker-start t) ;; will start only if not running
;; Load the html rendering packages
(if newsticker-html-renderer
(cond ((eq newsticker-html-renderer 'w3m-region)
(require 'w3m))
((eq newsticker-html-renderer 'w3-region)
(require 'w3-auto))
((eq newsticker-html-renderer 'newsticker-htmlr-render)
(require 'htmlr))))
(funcall newsticker-frontend))
;; ======================================================================
;;; Toolbar
;; ======================================================================
(defun newsticker-browse-url-item (feed item)
"Convert FEED ITEM to html and call `browse-url' on result."
(interactive)
(let ((t-file (make-temp-file "newsticker")))
(with-temp-file t-file
(insert "<?xml version=\"1.0\" encoding=\"utf-8\"?>
<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
<html xmlns=\"http://www.w3.org/1999/xhtml\">
<body>")
(insert "<h1>" feed ": " (newsticker--title item) "</h1>")
(insert (format-time-string newsticker-date-format
(newsticker--time item)))
(insert "<br/>")
(insert (or (newsticker--desc item) "[No Description]"))
(when (newsticker--enclosure item)
(insert "<br/><hr/><i>")
(newsticker--insert-enclosure item nil)
(insert "</i>"))
(when (newsticker--extra item)
(insert "<br/><hr/><tt>")
(newsticker--print-extra-elements item nil)
(insert "</tt>"))
(insert "</body></html>"))
(browse-url t-file)))
(provide 'newst-reader)
;;; newst-reader.el ends here
|
