ZNC - Recent changes [en]

Webadmin

2010-09-07T21:09:18Z

Usage:

← Older revision		Revision as of 21:09, 7 September 2010
Line 9:		Line 9:
	{{Module arguments		{{Module arguments
	\| type = global }}		\| type = global }}
		+	* -ipv4
		+	* -ipv6
		+	* -noircport
		+
		+	The default port seems to be 8080, unless you use SSL, in which case the port is the port number ZNC is bound to.

	=== Functions ===		=== Functions ===

User:L0xin

2010-09-07T21:01:13Z

New user account

User:DarthGandalf/modperl

2010-09-07T11:30:57Z

moved [[User:DarthGandalf/modperl]] to [[Modperl]] New perl modules!

Modperl

2010-09-07T11:30:57Z

deleted "[[Modperl]]" Deleted to make way for move

User:DarthGandalf/modperl

2010-09-07T11:27:10Z

Link to old modperl

← Older revision		Revision as of 11:27, 7 September 2010
Line 2:		Line 2:

	Modperl allows you to use modules written on perl.		Modperl allows you to use modules written on perl.
		+
		+	This page describes module since ZNC 0.095. If you still need help on old modperl, look [[Modperl/old\|here]].

	== Compiling ==		== Compiling ==

Modperl

2010-09-07T11:23:34Z

moved [[Modperl]] to [[Modperl/old]] Was changed to another module in 0.095

User:DarthGandalf/modperl

2010-09-06T03:21:42Z

Sockets:

← Older revision		Revision as of 03:21, 6 September 2010
Line 214:		Line 214:
	}		}
	All sockets are instances of special classes derived from <code>ZNC::Socket</code>.		All sockets are instances of special classes derived from <code>ZNC::Socket</code>.
-	ZNC::Socket have all the same methods as ~~CSocket~~, except Connect and Listen.	+	ZNC::Socket have all the same methods as Csock, except Connect and Listen.
-	Callbacks have different names from ones of ~~CSocket~~, they are described later.	+	Csock's reference can be found [http://csocket.net/docs/annotated.html here].
		+	To get reference to associated module, use <code>GetModule</code>.
		+	Callbacks have different names from ones of Csock, they are described later.

-	To create socket, use ~~function~~ CreateSocket. First argument is the name of your socket class. The function creates socket and calls method <code>Init</code> of it with the rest of arguments. Reference to the new socket is returned.	+	To create socket, use module's method CreateSocket. First argument is the name of your socket class. The function creates socket and calls method <code>Init</code> of it with the rest of arguments. Reference to the new socket is returned.

	To connect socket, use method <code>Connect</code>. It gets 2 required arguments - hostname and port, and several optional named arguments:		To connect socket, use method <code>Connect</code>. It gets 2 required arguments - hostname and port, and several optional named arguments:
Line 324:		Line 326:
	* OnReadLine - is called for every new line from socket. The line, including ending \n (or \r\n) is in argument. It's called only if you enabled this feature for the socket.		* OnReadLine - is called for every new line from socket. The line, including ending \n (or \r\n) is in argument. It's called only if you enabled this feature for the socket.
	* OnAccepted - is called for listening socket for every new connection. Arguments are hostname and port of remote end. The callback should return undef if you don't need the connection, or reference to new socket, which will be used for this connection.		* OnAccepted - is called for listening socket for every new connection. Arguments are hostname and port of remote end. The callback should return undef if you don't need the connection, or reference to new socket, which will be used for this connection.
		+
		+	If callback On* dies/croaks, the socket is closed, but if you want to close socket, use method <code>Close</code> instead.
		+	If Init croaks, behavior is undefined.

FAQ

2010-09-05T14:59:15Z

Rehash

← Older revision		Revision as of 14:59, 5 September 2010
(One intermediate revision not shown)
Line 96:		Line 96:
	server -m my.bouncer.net:+6697 user3:password3 -i Nickname AltNick Email Fullname		server -m my.bouncer.net:+6697 user3:password3 -i Nickname AltNick Email Fullname
	}		}
		+
		+	=== I added several different servers, but ZNC connects only to one of them! ===
		+	You need to have separate user per IRC network (see previous question).
		+	Additional servers for the same user are for fallback.
		+	If one server doesn't work, ZNC tries to connect to another server.
		+	So you can add several servers of one network to server list of one user.

	=== How do I add a new user? ===		=== How do I add a new user? ===
Line 157:		Line 163:
	=== My IRC-Client doesnt allow multiple connections to one server/host ===		=== My IRC-Client doesnt allow multiple connections to one server/host ===
	Try to use different local aliases for the bnc-host.		Try to use different local aliases for the bnc-host.
		+
		+	=== How to reload ZNC config without restart? ===
		+	The best way is '''NOT''' to change znc.conf and other files manually while ZNC is running.
		+	Try to use [[webadmin]] or [[admin]] instead, or use <code>/msg *status help</code>
		+
		+	If you ''really'' need to rehash config from file, there're 2 ways to do that: from IRC (<code>/msg *status rehash</code>)
		+	and from shell (<code>pkill -SIGHUP znc</code>).

User:DarthGandalf/modperl

2010-09-05T11:28:15Z

Sockets:

Show changes

Talk:Charset

2010-09-04T00:02:13Z

Reverted edits by 91.214.46.223 (talk) to last revision by Silverleo

← Older revision		Revision as of 00:02, 4 September 2010
Line 2:		Line 2:
	To have #blabla in utf8 and #foo in ISOxxxx.		To have #blabla in utf8 and #foo in ISOxxxx.
	* yeah that's on my to do list, but I won't work on it any time soon. ''[[User:Flakes\|Flakes]] 20:05, 23 June 2010 (CEST)''		* yeah that's on my to do list, but I won't work on it any time soon. ''[[User:Flakes\|Flakes]] 20:05, 23 June 2010 (CEST)''
-
-	~~== Hi all ==~~
-
-	~~Sorry admin - my post is test~~

Talk:Charset

2010-09-03T22:29:15Z

Hi all: new section

← Older revision		Revision as of 22:29, 3 September 2010
Line 2:		Line 2:
	To have #blabla in utf8 and #foo in ISOxxxx.		To have #blabla in utf8 and #foo in ISOxxxx.
	* yeah that's on my to do list, but I won't work on it any time soon. ''[[User:Flakes\|Flakes]] 20:05, 23 June 2010 (CEST)''		* yeah that's on my to do list, but I won't work on it any time soon. ''[[User:Flakes\|Flakes]] 20:05, 23 June 2010 (CEST)''
		+
		+	== Hi all ==
		+
		+	Sorry admin - my post is test

User:DarthGandalf/modperl

2010-09-03T18:30:49Z

Subpages:

New page

{{DISPLAYTITLE:modperl}}

Modperl allows you to use modules written on perl.

== Compiling ==
First, you need to use ./configure with option --enable-perl.

To build modperl, you need some files produced by [http://www.swig.org/ SWIG].
They are not shipped with ZNC because of huge size (several megabytes).
There're 2 ways to get them:
# Install swig. Needed files will be generated automatically when you run <code>make</code> in znc source dir to compile znc.
# Download these files (link here) to <znc-source>/modules/modperl/ and add option --disable-swig to ./configure

== Usage ==

Loading and unloading of perl modules is similar to C++ modules.
For example, you can use <code>/znc loadmod</code> or [[webadmin]].

If you unload modperl, all perl modules are automatically unloaded too.

{{Module arguments|type=global}}

== Writing new perl modules ==
=== Basics ===

Every perl module is file named like modulename.pm and is located in usual modules directories.
The file must contain package with exactly the same name as the module itself. (See [[example]])
The module should be derived from <code>ZNC::Module</code>.

Description of the module is the return value from a <code>sub description</code>.
All callbacks have the same name as in C++, and have the same arguments.

<code>sub OnShutdown</code> is used as destructor (instead of perl's DESTROY).
<code>OnShutdown</code> is called when the module is going to be unloaded.

Don't begin names of your member data fields with underscore (_) - some of them are used by modperl internally.
sub OnShutdown {
my $self = shift;
$self->{foo} = "foo"; # OK
$self->{_bar} = "bar"; # Fail, probably will work but can randomly stop working.
}

=== Strings ===

All ZNC classes are accessible from perl with <code>ZNC::</code> prefix. The exception is CString.
All uses of CString by value is transparently translated to/from perl string scalars.
Though if a var isn't a string, you might need to explicitly stringify it:
// C++
void Foo(const CString& s);

# perl
my $str = "bar";
ZNC::Foo($str); # OK
my $num = 42;
ZNC::Foo($num); # Fail
ZNC::Foo("$num"); # OK
ZNC::Foo($num . ""); # OK
ZNC::Foo(ZNC::String->new($num)); # OK, see below about ZNC::String
If you need to ''call'' a function which gets CString by reference, and returns a value in it,
there's a class named <code>ZNC::String</code>:
// C++
void Foo(CString& s) {
s = "bar";
}

# perl
my $s = ZNC::String->new;
ZNC::Foo($s);
print $s->GetPerlStr; # prints 'bar' to stdout
As you see, to get normal string from <code>ZNC::String</code> there's a method <code>GetPerlStr</code>.
You can construct non-empty <code>ZNC::String</code> using an argument to <code>new</code>.
This constructor can get string scalars, integer scalars, float scalars.

When you implement a module hook which accepts <code>CString&</code>, no ZNC::String magic is needed, it just works:
sub OnChanMsg {
my $self = shift;
# @_ == (nick, channel, message)
if ($_[0]->GetNick eq "Fish" || $_[2] eq "kwaa") {
$_[2] = "moo!"
}
}

=== Module's NV ===

There're some issues with using std iterators from perl, so class CModule got new methods: <code>GetNVKeys</code> which returns list of names of all NV values of the module, and <code>ExistsNV</code> which checks if specified variable exists.
sub OnModCommand {
my $self = shift;
my @nvkeys = $self->GetNVKeys;
if ($self->ExistsNV("foo")) {
$self->SetNV("bar", $self->GetNV("foo"));
$self->DelNV("foo");
}
....
}
Also there's another interface for accessing NVs - perl hash. (But for big number of values it's slow)
sub OnModCommand {
my $self = shift;
my $nv = $self->NV;
while (my ($key, $value) = each %$nv) {
...
}
my @nvkeys = keys %$nv;
$nv->{foo} = "bar";
$self->PutModule($nv->{foo});
delete $nv->{foo};
}
Of course, you can use <code>$self->{foo}</code> for storing temporary values, but NV data is stored on disk.

=== Web ===

==== CTemplate ====

Instead of operator[] use set:
// C++
CTemplate& tmpl = ...;
tmpl["name"] = "value";
CTemplate& row = tmpl.AddRow("SomeTable");
row["foo"] = "bar";

# perl equivalent
my $tmpl = ...;
$tmpl->set("name", "value");
my $row = $tmpl->AddRow("SomeTable");
$row->set("foo", "bar");

==== Subpages ====
If you want to have subpages for the module, use helper function <code>ZNC::CreateWebSubPage</code>.
It accepts one required argument - name of the subpage, and several optional named arguments:
* title - text for displaying subpage name. By default it's the same as name.
* params - reference to hash of parameters which will be used in URL linking to the subpage.
* admin - set to true value if subpage should be accessible only by admins.

There're 2 ways: using AddSubPage/ClearSubPages and overriding GetSubPages.
sub OnLoad {
my $self = shift;
$self->AddSubPage(ZNC::CreateWebSubPage('page1'));
$self->AddSubPage(ZNC::CreateWebSubPage('page2', title=>'Page N2'));
$self->AddSubPage(ZNC::CreateWebSubPage('page3', params=>{var1=>'value1', var2=>'value2'}, admin=>1);
1
}
The second way - to override GetSubPages.
Perhaps it may be better if list of subpages changes often in runtime.

But don't return pointer to local variable! Perl destroys objects when reference count goes to zero. In these 2 examples additional reference to returned object is stored in $self->{webpages}.
sub OnLoad {
my $self = shift;
$self->{webpages} = ZNC::VWebSubPages->new;
1
}
sub OnModCommand {
my $self = shift;
my $cmd = shift;
$self->{webpages}->push(ZNC::CreateWebSubPage($cmd));
}
sub GetSubPages {
my $self = shift;
return $self->{webpages}
}

sub GetSubPages {
my $self = shift;
my $result = ZNC::VWebSubPages->new;
$result->push(ZNC::CreateWebSubPage('foo'));
$self->{webpages} = $result;
return $result;
}

ZNC

2010-09-03T02:51:35Z

Further Info: +link to new page

← Older revision		Revision as of 02:51, 3 September 2010
Line 33:		Line 33:
	* [[ZNC Backup]]		* [[ZNC Backup]]
	* [[ExternalTools]]		* [[ExternalTools]]
		+	* [[StartSSL\|Using signed SSL cert]]

	=== Writing modules ===		=== Writing modules ===

StartSSL

2010-09-02T15:26:55Z

New page

If you want to use your StartSSL web server certificate in ZNC, you need to put your private key and the your certificate into ~/.znc/znc.pem. The certificate now gets validated, but the validation fails, since the root certificate is properly not know on your machine (while most browser come built-in with the root certificate). So you either make the certificate known to your machine (and all your ZNC users) or your put the root cert into your znc.pem file like the following:

# <code>cd ~/.znc/</code>
# <code>wget https://www.startssl.com/certs/sub.class1.server.ca.pem -O startssl.com.root.pem</code>
# <code>cat startssl.com.root.pem >> znc.pem</code>

It seems the order in your znc.pem must be "key", "own cert" and "root cert". If you get connection errors, make sure you done it right. You can test your certificate without connecting to znc with the following command:

<code>openssl s_client -showcerts -connect domain.tld:6667</code>
Change the domain and port to your domain and znc's listening port.