
PHPBB2FF - PHP BB2 Feed Filter
(c) 2004 Alexandre Erwin Ittner
E-mail: aittner ARROBA netuno.com.br


$Id: LEIAME,v 1.3 2004/11/14 21:33:49 dermeister Exp $



- OBJETIVO

Este script l a lista de tpicos de fruns baseados no phpBB2
(http://www.phpbb.com) e os apresenta em um formato XML legvel
por leitores RSS.  Em suma, permite o acompanhamento de fruns
de discusso atravs de um leitor RSS (como o Liferea --
http://liferea.sourceforge.net).

ATENO: Vale lembrar que esse script l os dados a partir do HTML
existente no frum!  Qualquer mudana no frum provavelmente o far
parar de funcionar! 

O script funciona bem com os temas padres do phpBB2 (testei bastante
com o subSilver).  Temas que diferem deste apenas pela formatao
*provavelmente* funcionaro. Temas com alteraes estruturais no HTML
*dificilmente* funcionaro.




- DEPENDNCIAS

O script foi escrito em Perl e usa o GNU wget para obter o contedo
das pginas. Estes dois so comumente encontrados em sistemas Unix e
vem por padro na maioria das distribuies Linux.

Um leitor RSS que suporte a obteno de feeds a partir da sada de
comandos tambm  necessrio, mas caso seu leitor preferido no suporte
isso, voc pode usar o cron (8) para rodar o script de tempos em tempos,
redirecionar sua sada para um arquivo temporrio e configurar seu leitor
para obter os dados a partir desse arquivo.



- LICENA DE USO

Este programa  um software livre que pode ser copiado e distribudo
nos termos da Licena Pblica Geral GNU (GNU General Public License -
GPL) verso 2 da licena ou, a seu critrio, qualquer verso posterior.
Este programa foi criado na expectativa de ser til, porm NO POSSUI
NENHUMA GARANTIA, EXPRESSA, IMPLCITA OU DE ATENDIMENTO A ALGUMA
DETERMINADA FINALIDADE.  Para maiores informaes consulte o texto
completo da Licena Pblica Geral GNU no arquivo COPYING distribudo
juntamente com este programa.



- INSTALAO

Sem segredos aqui. Simplesmente copie o arquivo "phpbb2ff.pl" para algum
lugar no seu path (/usr/local/bin  uma boa opo).




- CONFIGURAO

Aqui h um pequeno truque: o script precisa saber o endereo raiz do
frum e o nmero do frum que voc deseja ler. A sintaxe :

    phpbb2ff.pl <endereo> <nmero>

Obter o nmero  simples. Digamos que voc queira acompanhar o frum
"phpBB Support", um dos fruns existentes no site do phpBB. Para isso,
acesse a lista de fruns ( http://www.phpbb.com/phpBB/ ) e copie o link
para o frum desejado - que  http://www.phpbb.com/phpBB/viewforum.php?f=1

O nmero do frum  o argumento do parmetro "f", e o endereo vai at
a ltima barra. Para este caso, a linha de comando fica:

    phpbb2ff.pl http://www.phpbb.com/phpBB/ 1

No esquea a barra! Digite isso na linha de comando e faa o teste! Se
tudo funcionar, configure seu leitor RSS para extrair os feeds a partir
desse comando.



- BUGS CONHECIDOS

O script no manupula corretamente os tpicos estticos (que parmanecem
sempre no incio das listagens) ou que apaream em mais de um frum
(esses acabam duplicados).




- MINI FAQ

P: O que levou voc a escrever esse script?

R: Costumo acessar certos fruns baseados no phpBB2 com relativa
frequncia, e estava perdendo muito do meu precioso tempo *apenas* para
ver se h algo novo neles. J uso feeds RSS a algum tempo para agilizar
o acesso a contedo na WEB, e consultar os fruns por RSS me pareceu
natural. Infelizmente, apesar de o phpBB2 ter mods para emitir a lista de
tpicos em RSS ( veja http://www.phpbb.com/phpBB/catdb.php?cat=56 ), so
poucos fruns possuem esse recurso instalado. Veio ento a necessidade
de extrair essas informaes a partir do HTML, coisa que eu j tinha
feito para outros sites e fruns.


P:  Porque Perl e wget?

R: Foi uma escolha natural: Perl  uma linguagem padro nos sistemas Unix,
e  realmente poderosa quando o assunto  manipulao de texto. Usei o
wget para no cair na estupidez de reinventar a roda.


P: O script funciona no Windows?

R: Provavelmente. No testei e no vou testar, mas se voc quiser fez-lo,
pegue um porte do Perl e do GNU wget para Windows (comece procurando
na Sourceforge). Duvido que exista algum leitor de feeds para Windows
que suporte a obteno de dados a partir da sada de comandos, mas voc
pode resolver isso com arquivos temporrios e alguma ferramenta para
agendamento de tarefas.


P: Porque o script pode parar de funcionar a qualquer momento?

R: O script l HTML e a extrao do contedo depente deste. Apesar
de o script tomar uma srie de cuidados para isolar a formatao do
contedo semanticamente til, mudanas no HTML o uso de temas no usuais
PROVAVELMENTE faro ele se perder.


P: Por que a licena GPL?  Porque o script no tem garantias?

R: Escrevi este script para atender uma necessidade pessoal, que
acredito tambm existir para outras pessoas e a GPL permite que este
script seja adaptado por outros e para outras necessidades. Eu o
disponibilizo gratuitamente para voc. Pegue, teste e -- se funcionar
-- use.  S no venha me culpar caso o script pare de funcionar e voc
no seja informado a tempo da ltima mancada militar do Bush, atentado
terrorista ou invaso aliengena.


P: O script parou de funcionar, o que eu fao?

R: *Talvez* eu j o tenha corrigido. Experimente pegar a ltima verso.


P: O script parou de funcionar e a ltima verso no funciona, mas eu
   corrigi ele. Posso mandar para voc?

R: Claro! Eu o colocarei no site para que outros possam us-lo.


P: Estou com problemas/dvidas com o script, posso pedir ajudar para
   voc por e-mail?

R: Voc pode, mas no posso garantir que vou responder a tempo. E-mails
com dvidas sobre como usar esse script no Windows ou com palavras
como "naum"/"axu"/"keru"/etc. sero graciosamente redirecionados para
/dev/null.


