Montando um FServe (File Server) no xchat

Enviada: Ter Jan 04, 2005 1:59 pm

1. O que é um fserve ?

Fserve (File Server) como o próprio nome diz é um servidor de arquivos, amplamente utilizado em canais de IRC (Internet Relay Chat) para se compartilhar coisas.

2. Mas por que eu vou querer montar um ?

Posso até ouvir você fazendo essa pergunta, e diria que você, provavelmente, é um tipico leecher. Então, eu sugiro que você deixe de ser um "vampiro" sugador e comece a pensar mais na comunidade, pois da mesma forma que você quer pegar as coisas, outras pessoas também querem, e quanto mais gente disponibilizando fica mais fácil pra baixar. Também diria pra você dar uma lida na mensagem "O prazer de compartilhar"" veiculada na Dicas-L.
Bom, além desse lado da comunidade, de compartilhar e talz, também existe o lado "mesquinho". Quer dizer, quando você possui um fserve você ganha "voice" (+v) e com isso furamos a fila (queue) em outros fserves e Bots, assim baixamos mais rápido também.

3. Do que preciso ?

Basicamente precisamos de uma instalação do xchat versão 2.x funcional, e do Tuxserve.
A última versão é a 0.0.12.2alpha, mas note que foi lançado um bugfix para essa versão. Então devemos baixar os pacotes:

. tuxserve-0.0.12.2alpha.tar.gz
. tuxserve-bugfix-20041222.tar.gz

4. Instalação

O processo de instalação é bem simples. Estando no diretório onde os dois arquivos acima foram salvos, basta:

Código:

$ tar xzvf tuxserve-0.0.12.2alpha.tar.gz
$ tar xzvf tuxserve-bugfix-20041222.tar.gz
$ mv dcc.c tuxserve-0.0.12.2alpha/
$ mv queue.c tuxserve-0.0.12.2alpha/
$ cd tuxserve-0.0.12.2alpha
$ make
$ make install

Note que eu não errei. A instalação (make install) deve ser executada pelo usuário que rodará o xchat, pois o que esse comando faz é apenas criar o subdiretório ~/.xchat2/tuxserve/ e copiar para lá todos os arquivos necessários para rodar o fserve. É importante salientar, que após o make install é dito ao usuário que existe a opção "make autoload", que faz com que o fserve seja iniciado junto com o xchat, entretanto, nem o autor do Tuxserve recomenda utilizar essa opção devido ao fato do aplicativo estar numa versão alpha e potencialmente instavel.

5. Configuração

A configuração pode ser feita de dois modos:

1. Através do próprio xchat;
2. Editando diretamente o arquivo de configuração do fserve.

A primeira opção é mais recomendada num primeiro momento, pois é mais inteligivel. Mas após um certo tempo, editar o arquivo é mais pratico. Aqui aboradarei a segunda opção pois é mais fácil de ser explicada em poucas palavras.

O arquivo de configuração é o ~/.xchat2/tuxserve/config.cfg (um arquivo texto simples).

As configurações disponiveis nesse arquivo e seus significados são abordados a seguir. Os comentarios estaram em azul.

[general]
config_version}0.0.12.2alpha

autoon}1
Aqui definimos se o fserve inicia assim que carregado ou se ele deve esperar um acionamento manual com "/ts on". As opções, como em quase todas aqui, são 0 (desativado) e 1 (ativado).

auto_clear}1
Aqui definimos se o fserve deve limpar a fila de pessoas aguardando o download após reinicio do servidor. '0' ele mantém a fila após ser reiniciado; '1' ele limpa a fila

auto_resume}0
Aqui definimos se ele ao ser reiniciado começa a re-enviar os arquivos para as pessoas que estavam na fila. Obviamente não tem função caso auto_clear esteja setada para 1. Opções: '0' desativado, '1' ativado

channels}#canal_1 #canal_2 #canal_3
Aqui definimos os canais nos quais o fserver deve atuar. Podemos colocar diversos canais, sendo estes separados apenas por um espaço simples

trigger0}Nome_do_trigger
Aqui definimos o nome do primeiro trigger, sendo que podemos ter até 8 triggers (numerados de 0 a 7). Para acrescentarmos mais triggers, bastariamos colocar mais uma opção 'trigger1}Nome_do_trigger_1'. Pra quem não sabe, trigger é o que os outros users vão digitar para acessar seu servidor, algo tipo '/ctcp seu_nick Nome_do_trigger'

trigger0_dir}/diretorio_onde_os_arquivos_a_serem_compartilhados_estão/
Aqui definimos o diretorio onde estão os arquivos a serem compartilhados pelo trigger0. Se criarmos um trigger1, devemos acrescentar mais uma opção 'trigger1_dir', pois cada trigger esta ligado a um trigger_dir. Note que os usuarios terão acessos a todos os subdiretorios do caminho especificado, mas não poderão "subir" para diretorios acima deste.

trigger_type}1
Aqui definimos se o fserve vai ser tipo ctcp (1) ou public (0). A diferença é que no modo ctcp a pessoa tem que digitar '/ctcp seu_nick Nome_do_trigger' para acessar seu server. No caso do public basta apenas '!Nome_do_trigger'. Entretanto, essa segunda forma não é permitida pela imensa maioria dos canais de irc.

trigger_levels}AAAAAAAA
Aqui definimos o nivel de acesso de cada trigger, ou seja, quem pode acessa-lo. As opções são: '+' (apenas quem tem voice, hops e ops podem acessar), '%' (apenas hops e ops podem acessar), '@' (arroba)(apenas ops podem acessar), e 'A' (acesso liberado pra qualquer um). Mesmo que se use apenas um trigger, deve-se definir o nivel de acesso para os 8 possiveis de serem construidos. Cada caracter representa um trigger.

note}O_que_vc_quiser_dizer_no_seu_anuncio_padrão
Aqui definimos o que irá escrito no anuncio do seu server, tanto num anuncio programado e/ou forçado, quanto quando alguém digita '!list' no canal. Esse é o anuncio padrão, mais a frente veremos que é possivel definir um anuncio para cada canal em que o server foi programado para atuar.

use_raws}0
Aqui definimos se queremos ver o anuncio de nosso server quando alguém digita '!list' no canal. '0' vemos, '1' não vemos. É bom deixar como '0' no começo para você ver como esta seu anuncio, as cores e talz. Depois você pode desativar se quiser.

temp_type}1
Essa opção determinada como o xchat trabalhará com arquivos temporários. O autor sugere que não se altere o valor default a menos que o fserve comece a dar mensagem de erro sobre temp files. O valor padrão é '1'.

show_welcome}2
Aqui definimos se a pessoa ao entrar no nosso server vai receber uma mensagem de boas-vindas ou não. Os valores possiveis são: '0' a pessoa não vê mensagem nenhuma, '1' é exibida uma mensagem aleatoria obtida do fortune (requerido para funcionar), e '2' é exibida a mensagem contida em ~/.xchat2/tuxserve/welcome. Por padrão esse arquivo não existe, devendo ser criado manualmente (arquivo texto simples). Não há limite para o tamanho da mensagem, mas o autor recomenda não escrever mais do que 255 caracteres por linha.

show_dir_info}0
Se ativado (1) exibe as informações contidas em .TuxServe_info-<nome_do_diretorio>, arquivo esse que deve ser criado em cada diretório que você quiser exibir alguma informação. Padrão é '0' desativado.

inform_banned}1
Exibe uma mensagem informando a um usuario que ele foi banido do seu server. '0' não exibe, '1' exibe.

banned_no_list}1
Esconde o anuncio do seu fserve, quando um usuario banido digita '!list'.

priority_queue}1
Essa opção é para dar prioridade na fila para ops, hops e pessoas com voice, sendo '1' ativa a prioridade para eles, '0' não ativa. Entretanto, segundo o autor, na versão atual isso não faz diferença e essa funcionalidade só será totalmente implementada no próximo release.

show_hidden}0
'0' não exibe arquivos ocultos, '1' exibe.

auto_close}1
Fecha a tab aberta pelo server assim que o usuario que estava no fserver fechar a janela dele.

advert_timer}3600
Intervalo em segundos entre os anuncios. Repare que muitos canais proibem esse tipo de propaganda, ou exigem um intervalo bem alto (tipicamente 1 hora = 3600 segundos).

advert_full}1
Aqui definimos se quando a fila esta cheia o anuncio do seu fserver não é feito. '0' ele continua sendo feito; '1' ele não é feito enquanto uma vaga não for aberta. O autor do programa recomenda deixar em '1'

max_queues}10
Tamanho maximo da fila de espera por downloads.

user_queues}2
Numero maximo de posições que um unico usuario pode ocupar na fila de downloads.

max_sends}1
Numero de envios concorrentes (ao mesmo tempo) que seu server pode fazer. Note que aqui não definimos a velocidade maxima de envio. Essa opção é defina no menu preferences do proprio xchat.

user_sends}1
Caso max_sends seja maior que 1, vc deve definir aqui o numero maximo de envios concorrentes para um unico usuario.

max_users}5
Numero maximo de usuarios acessando seu fserver ao mesmo tempo. Sugiro que deixe um numero maior que 1, pois quando um usuario esta fazendo download de você, ele fica ocupando um lugar na fila, e também quando alguém acessa seu server mas ao sair o programa cliente que ele estava usando não envia o sinal corretamente para fechar a sessão, ele também fica bloqueando uma vaga.

idle_time}90
Tempo em segundos em que o usuario que acessar fserver e não digitar nada será desconectado.

send_now}64
Tamanho maximo em kb dos arquivos que são enviados imediatamente, assim que são requeridos. Bom para quem disponibiliza um arquivo de packs ou uma lista de trocas.

colour0}4
colour1}12
colour2}9
colour3}7
colour4}14
colour5}12
colour6}13
Cores utilizadas nas fontes pelo TuxServe. As opções são: '0' branco, '1' preto, '2' azul escuro, '3' verde, '4' vermelho, '5' vinho, '6' roxo, '7' laranja, '8' amarelo, '9' verde claro, '10' algo entre azul e verde, '11' um tipo de azul, '12' azul (sinceramente, pra mim é a mesma cor do '2'),'13' pink, '14' cinza escuro, '15' cinza mais claro.

=== Agora começam as configurações personalizadas de cada canal ====
[#canal_1]
Nome do canal

channel_serve}1 0 0 0 0 0 0 0 0
Aqui definos os triggers ativos no canal. '0' desativa e '1' ativa. Nesse caso, apenas o trigger0 esta ativo e os outros 7 estão desativados.

advert_settings}1 1 0 0 0 0 0 0 0 1
Aqui ativamos ('1') e desativamos ('0') as informações exibidas no anuncio do seu server. Na ordem as opções são: o numero de arquivos sendo enviados, o numero de arquivos na fila, numero de usuarios acessando o fserve, a velocidade total de envio, a velocidade record de envio, o total em kB já enviado pelo seu fserver, o numero total de arquivos ja enviados, o numero de envios que falharam, o numero de acessos ao seu fserver, e uma observação (lembra da opção 'note' acima?).

timer}0
Intervalo entre cada anuncio automatico. '0' desativa esse anuncio. Assim só quando as pessoas digitarem '!list' o anuncio será exibido.

chan_note}O_que_vc_quiser_escrever_aqui.
Esse campo é a observação citada no final do 'advert_settings' acima. Caso você tenha habilitado a sua exibição e esse campo não exista, será exibida a mensagem definida em 'note}'.

====================================================================
Agora basta repetir todos os campos delimitados acima para cada canal definido em 'channels' lá no inicio

Abaixo algumas estatisticas geradas automaticamente pelo fserver assim que ele for sendo acessado.
[stats]
record_speed}0
record_speed_user}none
files_sent}2
data_sent}181436
data_type}kb
accessed}44
sends_failed}6

Ufa ... a configuração acabou.

6. Colocando pra funcionar

Basta iniciar o xchat normalmente, ir na tab ou janela de status do servidor pelo qual você acessa os canais e digitar:

Código:

/load ~/.xchat2/tuxserve/tuxserve.so
/ts on

O segundo comando só é necessário quando a opção 'autoon' esta desabilitada ('0').

Prontinho, o fserver esta funcionando. Agora basta um '/ts help' pra você saber como obter e alterar as configurações em tempo real do seu fserver.

7. Observações finais

. É muito importante que se coloque a '/' no final do 'trigger_dir', senão os usuários não conseguiram acessar os arquivos em seu fserver;
. É extremamente recomendado que apenas se carregue o fserver após ter entrado em todos os canais em que ele deve atuar.
. Para maiores detalhes: http://tuxserve.sourceforge.net/help.php

Espero que gostem.

Ederson.