/usr/share/freepops/lua/flatnuke.lua is in freepops 0.2.9-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 | -- --------------------------- READ THIS PLEASE ----------------------------- --
-- This file is not only the flatnuke webnews plugin. Is is also a well
-- documented example of webnews plugin.
--
-- Before reading this you should learn something about lua. The lua
-- language is an excellen (at least in my opinion), small and easy
-- language. You can learn something at http://www.lua.org (the main website)
-- or at http://lua-users.org/wiki/TutorialDirectory (a good and short tutorial)
--
-- Feel free to contact the author if you have problems in understanding
-- this file
--
-- To start writing a new plugin please use skeleton.lua as the base.
-- -------------------------------------------------------------------------- --
-- ************************************************************************** --
-- FreePOPs flatnuke xml news interface
--
-- $Id: flatnuke.lua,v 1.26 2007/01/14 16:49:36 gareuselesinge Exp $
--
-- Released under the GNU/GPL license
-- Written by Simone Vellei <simone_vellei@users.sourceforge.net>
-- ************************************************************************** --
-- these are used in the init function
PLUGIN_VERSION = "0.0.6"
PLUGIN_NAME = "flatnuke"
PLUGIN_REQUIRE_VERSION = "0.2.0"
PLUGIN_LICENSE = "GNU/GPL"
PLUGIN_URL = "http://www.freepops.org/download.php?module=kernel.lua"
PLUGIN_HOMEPAGE = "http://www.freepops.org/"
PLUGIN_AUTHORS_NAMES = {"Simone Vellei"}
PLUGIN_AUTHORS_CONTACTS = {"simone_vellei (at) users (.) sourceforge (.) net"}
PLUGIN_DOMAINS = {"@flatnuke","@..."}
PLUGIN_PARAMETERS = {}
PLUGIN_DESCRIPTIONS = {
it=[[
Questo plugin è un plugin aggregator specializzato nei
siti web fatti con il CMS
FlatNuke , o altri siti che usano lo stesso for mato delle news
come il sito di
FreePOPs. Dato che in un sito FlatNuke le news sono memorizzate in semplici
file XML questo plugin è in grado di prelevare tutte le news,
non solo le intestazioni come il plugin aggregator.
Ciò è molto utile se non vuoi sfogliare l' intero
sito web per leggere le news.
Per usare questo plugin dovete avere un nome utente con il dominio @flatnuke
(es.: qualcosa@flatnuke) e l'URL di una homepage flatnuke come password
(es.: http://flatnuke.sourceforge.net/, non c'è
bisogno di URL di file RSS
visto che FlatNuke mette gli RSS in una posizione nota e fissata.]],
en=[[
This plugin is an aggregator plugin specialized in the websites made with the
FlatNuke content management system, or other sites that use the same news
format like the FreePOPs website. Since in a FlatNuke site the news are stored
in plain XML files this plugin is able to fetch the whole news, and not only the
headings as the aggregator plugin does. This is really useful if you don't want
to surf the website to read the news.
To use this plugin you have to use a user name with the @flatnuke domain
(ex: something@flatnuke) and a flatnuke homepage URL as the password
(ex: http://flatnuke.sourceforge.net/, no need for the RSS file URL since
FlatNuke puts the RSS in a fixed and well known position.]]
}
-- Configuration:
--
-- Username must be ".....@flatnuke"
-- Password must be a flatnuke portal URI "http://flatnuke.sourceforge.net"
--
-- STAT takes URI/misc/backend.rss the RSS index file
-- and count the message number, uidl is the news timestamp.
-- RETR takes URI/news/UIDL.xml, the news is in XML format:
--
-- <!ELEMENT fn:news (fn:title, fn:avatar, fn:reads, fn:header, fn:body, fn:comments?)>
-- <!ATTLIST fn:news
-- xmlns:fn CDATA #FIXED "http://flatnuke.sourceforge.net/news">
-- <!ELEMENT fn:title #PCDATA>
-- <!ELEMENT fn:avatar #PCDATA>
-- <!ELEMENT fn:reads #PCDATA>
-- <!ELEMENT fn:header #PCDATA>
-- <!ELEMENT fn:body #PCDATA>
-- <!ELEMENT fn:comments (fn:comment)+>
-- <!ELEMENT fn:comment (fn:by,fn:post)>
-- <!ELEMENT fn:by #PCDATA>
-- <!ELEMENT fn:post #PCDATA>
--
-- We take the header and body news filed to mail message body and the title to
-- mail subject.
--
-- ************************************************************************** --
-- strings
-- ************************************************************************** --
-- Some of them are incomplete, in the sense that are used as string.format()
-- (read sprintf) arguments, so their %s and %d are filled properly
--
-- C, E, G are postfix respectively to Captures (lua string pcre-style
-- expressions), mlex expressions, mlex get expressions.
--
local flatnuke_string = {
-- This is the news title
titleC = "<fn:title>(.*)</fn:title>",
-- This is the news header
headerC = "<fn:header>(.*)</fn:header>",
-- This is the ews body
bodyC = "<fn:body>(.*)</fn:body>",
-- Freepops patch
patchC = "(<fn:patch>.*</fn:patch>)",
-- This identify an RSS item
itemE = "<item rdf:about=\".*\">",
-- This is the mlex expression to choos the item field
itemG = "<X>"
}
-- ************************************************************************** --
-- State
-- ************************************************************************** --
-- this is the internal state of the plugin. This structure will be serialized
-- and saved to remember the state.
internal_state = {
stat_done = false,
login_done = false,
domain = nil,
name = nil,
password = nil,
b = nil
}
-- ************************************************************************** --
-- Helpers functions
-- ************************************************************************** --
--------------------------------------------------------------------------------
-- Extracts the account name of a mailaddress
--
function get_name(s)
local d = string.match(s,"([_%.%a%d]+)@[_%.%a%d]+")
return d
end
--------------------------------------------------------------------------------
-- Converts HTML news tag into text
--
function html2txt(str)
str=string.gsub(str,"\n","")
str=string.gsub(str,"\t","")
str=string.gsub(str,"<[Tt][Rr]>","\n")
str=string.gsub(str,"</[Tt][Hh]>","\t")
str=string.gsub(str,"</[Tt][Dd]>","\t")
str=string.gsub(str,"<[Bb][Rr]>","\n")
str=string.gsub(str,"<[Uu][Ll]>","\n")
str=string.gsub(str,"</[Uu][Ll]>","\n\n")
str=string.gsub(str,"<[Ll][Ii]>","\n\t* ")
str=string.gsub(str,"<.->","")
return str
end
--------------------------------------------------------------------------------
-- Build a mail header date string
--
function build_date(str)
return(os.date("%a, %d %b %Y %H:%M:%S +0100",str))
end
--------------------------------------------------------------------------------
-- Build a mail header
--
function build_mail_header(title,uidl)
uidl=string.match(uidl,"/(%d*).xml")
return
"Message-Id: <"..uidl..">\r\n"..
"To: "..internal_state.name.."@"..internal_state.password.."\r\n"..
"Date: "..build_date(uidl).."\r\n"..
"Subject: "..title.."\r\n"..
"From: freepops@"..internal_state.password.."\r\n"..
"User-Agent: freepops "..PLUGIN_NAME..
" plugin "..PLUGIN_VERSION.."\r\n"..
"MIME-Version: 1.0\r\n"..
"Content-Disposition: inline\r\n"..
"Content-Type: text/plain; charset=\"iso-8859-1\"\r\n"..
"Content-Transfer-Encoding: quoted-printable\r\n"..
"\r\n"
end
--------------------------------------------------------------------------------
-- retr and top aree too similar. discrimitaes only if lines ~= nil
--
function retr_or_top(pstate,msg,data,lines)
-- we need the stat
local st = stat(pstate)
if st ~= POPSERVER_ERR_OK then return st end
local uidl = get_mailmessage_uidl(pstate,msg)
--some locals
local b = internal_state.b
-- build the uri
local uri = uidl
-- tell the browser to get the uri
local s = b:get_uri(uri)
--check it
if s == nil then
log.error_print("Asking for "..uri.."\n")
return POPSERVER_ERR_NETWORK
end
--get it
local title=string.match(s,flatnuke_string.titleC)
local header=string.match(s,flatnuke_string.headerC)
local body=string.match(s,flatnuke_string.bodyC)
local patch=string.match(s,flatnuke_string.patchC)
-- FreePOPs patches
if(patch ~= nil) then
patch=string.gsub(patch,"\t", "");
patch=string.gsub(patch,"\n", "");
patch=string.gsub(patch," ", "");
patch=string.gsub(patch,"<fn:patch>", "Updated ");
patch=string.gsub(patch,"</fn:patch>", " plugin\n");
patch="FreePOPs plugins update:\n"..patch.."\n"
else
patch = ""
end
if header == nil or body == nil or title == nil then
log.error_print("Error parsing: title="..
(title or "nil").." header="..
(header or "nil").." body="..(body or "nil"))
end
--clean it
header=html2txt(header)
body=html2txt(body)
title = string.gsub(title,"\n","")
--build it
local s = build_mail_header(title,uidl) ..
patch..
header .. "\r\n\r\n" ..
body.. "\r\n"
--hack it
local a = stringhack.new()
if lines ~= nil then
s = a:tophack(s,lines)
end
s = a:dothack(s)
--end it
s = s .. "\0"
--send it
popserver_callback(s,data)
return POPSERVER_ERR_OK
end
-- ************************************************************************** --
-- flatnuke functions
-- ************************************************************************** --
-- Must save the mailbox name
function user(pstate,username)
-- extract username
local name = get_name(username)
-- save name
internal_state.name = name
return POPSERVER_ERR_OK
end
-- -------------------------------------------------------------------------- --
-- Must login
function pass(pstate,password)
if internal_state.login_done then
return POPSERVER_ERR_OK
end
-- save the password
-- password is the flatnuke URI basename
if freepops.MODULE_ARGS ~= nil then
if (freepops.MODULE_ARGS.host ~= nil) then
internal_state.password = freepops.MODULE_ARGS.host
else
internal_state.password = password
end
end
-- build the uri
local user = internal_state.name
-- the browser must be preserved
internal_state.b = browser.new()
-- b:verbose_mode()
internal_state.login_done = true
return POPSERVER_ERR_OK
end
-- -------------------------------------------------------------------------- --
-- Must quit without updating
function quit(pstate)
return POPSERVER_ERR_OK
end
-- -------------------------------------------------------------------------- --
-- Update the mailbox status and quit
function quit_update(pstate)
return POPSERVER_ERR_OK
end
-- -------------------------------------------------------------------------- --
-- Fill the number of messages and their size
function stat(pstate)
-- check if already called
if internal_state.stat_done then
return POPSERVER_ERR_OK
end
-- shorten names, not really important
local b = internal_state.b
-- this string will contain the uri to get. it may be updated by
-- the check_f function, see later
local uri = internal_state.password.."/misc/backend.rss"
log.dbg("URI -"..uri.."-\n")
-- uses mlex to extract all the messages uidl and size
local function action_f (s)
-- calls match on the page s, with the mlexpressions
-- statE and statG
local x = mlex.match(s,flatnuke_string.itemE,
flatnuke_string.itemG)
-- the number of results
local n = x:count()
if n == 0 then
return true,nil
end
-- this is not really needed since the structure
-- grows automatically... maybe... don't remember now
set_popstate_nummesg(pstate,n)
-- gets all the results and puts them in the popstate structure
for i = 1,n do
local uidl = x:get (0,i-1)
--fucking default size
local size=1000
uidl = string.match(uidl,"about=\"(.*)\"")
if not uidl or not size then
return nil,"Unable to parse uidl"
end
-- set it
set_mailmessage_size(pstate,i,size)
set_mailmessage_uidl(pstate,i,uidl)
end
return true,nil
end
-- check must control if we are not in the last page and
-- eventually change uri to tell retrive_f the next page to retrive
local check_f = support.check_fail
-- this is simple
local retrive_f = support.do_retrive(b,uri)
-- this to initialize the data structure
set_popstate_nummesg(pstate,0)
-- do it
if not support.do_until(retrive_f,check_f,action_f) then
log.error_print("Stat failed\n")
return POPSERVER_ERR_UNKNOWN
end
-- save the computed values
internal_state["stat_done"] = true
return POPSERVER_ERR_OK
end
-- -------------------------------------------------------------------------- --
-- Fill msg uidl field
function uidl(pstate,msg)
return common.uidl(pstate,msg)
end
-- -------------------------------------------------------------------------- --
-- Fill all messages uidl field
function uidl_all(pstate)
return common.uidl_all(pstate)
end
-- -------------------------------------------------------------------------- --
-- Fill msg size
function list(pstate,msg)
return common.list(pstate,msg)
end
-- -------------------------------------------------------------------------- --
-- Fill all messages size
function list_all(pstate)
return common.list_all(pstate)
end
-- -------------------------------------------------------------------------- --
-- Do nothing
function noop(pstate)
return common.noop(pstate)
end
-- -------------------------------------------------------------------------- --
-- Unflag each message merked for deletion
function rset(pstate)
return POPSERVER_ERR_OK
end
-- -------------------------------------------------------------------------- --
-- Mark msg for deletion
function dele(pstate,msg)
return POPSERVER_ERR_OK
end
-- -------------------------------------------------------------------------- --
-- Get first lines message msg lines, must call
-- popserver_callback to send the data
function retr(pstate,msg,data)
return retr_or_top(pstate,msg,data)
end
-- -------------------------------------------------------------------------- --
-- Get message msg, must call
-- popserver_callback to send the data
function top(pstate,msg,lines,data)
return retr_or_top(pstate,msg,data,lines)
end
-- -------------------------------------------------------------------------- --
-- This function is called to initialize the plugin.
-- Since we need to use the browser we have to use
-- some modules with the dofile function
--
-- We also exports the pop3server.* names to global environment so we can
-- write POPSERVER_ERR_OK instead of pop3server.POPSERVER_ERR_OK.
--
function init(pstate)
freepops.export(pop3server)
log.dbg("FreePOPs plugin '"..
PLUGIN_NAME.."' version '"..PLUGIN_VERSION.."' started!\n")
-- the browser module
require("browser")
-- the common implementation module
require("common")
-- checks on globals
freepops.set_sanity_checks()
return POPSERVER_ERR_OK
end
-- EOF
-- ************************************************************************** --
|