To create new wiki account, please join us on #znc at Libera.Chat and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.

Timestamps and Keepnick: Difference between pages

From ZNC
(Difference between pages)
Jump to navigation Jump to search
>Kuja
m remove some commented out echos from the kvirc script
 
Andrio (talk | contribs)
Be more clear about when the module will change states.
 
Line 1: Line 1:
{{DISPLAYTITLE:keepnick}}
{{Core Module | version = 0.060}}
This module tries to get your primary nick, as specified in the ZNC config. Especially useful on IRC networks that do not have services like NickServ to reserve your name and prevent others from taking it.
== Usage ==
== Usage ==
If you want real timestamps you should use these settings for your user:
TimestampFormat = [%H:%M:%S]
AppendTimestamp = false
PrependTimestamp = true
It currently supports Channel, Query, Wallops, Notice and Servernotices
== Format ==
strftime arguments can be used for the timestamps, more details and arguments can be found at opengroup.org[http://opengroup.org/onlinepubs/007908799/xsh/strftime.html].
  %a - the locale's abbreviated weekday name.
  %A - the locale's full weekday name.
  %b - the locale's abbreviated month name.
  %B - the locale's full month name.
  %c - the locale's appropriate date and time representation.
  %C - the century number (the year divided by 100 and truncated to an integer) as a decimal number [00-99].
  %d - the day of the month as a decimal number [01,31].
  %D - same as %m/%d/%y.
  %e - the day of the month as a decimal number [1,31]; a single digit is preceded by a space.
  %h - same as %b.
  %H - the hour (24-hour clock) as a decimal number [00,23].
  %I - the hour (12-hour clock) as a decimal number [01,12].
  %j - the day of the year as a decimal number [001,366].
  %m - the month as a decimal number [01,12].
  %M - the minute as a decimal number [00,59].
  %n - a newline character.
  %p - the locale's equivalent of either a.m. or p.m.
  %r - the time in a.m. and p.m. notation; in the POSIX locale this is equivalent to %I:%M:%S %p.
  %R - the time in 24 hour notation (%H:%M).
  %S - the second as a decimal number [00,61].
  %t - a tab character.
  %T - the time (%H:%M:%S).
  %u - the weekday as a decimal number [1,7], with 1 representing Monday.
  %U - the week number of the year (Sunday as the first day of the week) as a decimal number [00,53].
  %V - the week number of the year (Monday as the first day of the week) as a decimal number [01,53]. If the week containing 1 January has four or more
      days in the new year, then it is considered week 1. Otherwise, it is the last week of the previous year, and the next week is week 1.
  %w - the weekday as a decimal number [0,6], with 0 representing Sunday.
  %W - the week number of the year (Monday as the first day of the week) as a decimal number [00,53]. All days in a new year preceding the first Monday
      are considered to be in week 0.
  %x - the locale's appropriate date representation.
  %X - the locale's appropriate time representation.
  %y - the year without century as a decimal number [00,99].
  %Y - the year with century as a decimal number.
  %Z - the timezone name or abbreviation, or by no bytes if no timezone information exists.
  %% - %.
== Scripts ==
=== KVIrc ===
This script '''requires''' these settings for your user:
TimestampFormat = {%H:%M:%S}
AppendTimestamp = false
PrependTimestamp = true
and here is it:
event(OnWallops,zncid)
{
%timefront = $str.lefttofirst($3,$char(32))
%timeappend = $str.rightfromlast($3,$char(32))
if($str.matchnocase(\{**\:**\:**\},%timefront))
{
%time = %timefront
%msg = $str.rightfromfirst($3,\})
} else {
if($str.matchnocase(\{**\:**\:**\},%timeappend))
{
%time = %timeappend
%msg = $str.lefttofirst($3,\{)
}
}
if($str.matchnocase(\{**\:**\:**\},%time))
{
echo -n -i=$msgtype(Wallops) $k($option(uinttimestampforeground))%time$k WALLOPS von $0 \[$1\@$2\] $str.rightfromfirst($3,\})
}
halt
}
event(OnServerNotice,zncid)
{
%chan = $window.list(channel,$ic)
%con = $window.list(console,$ic)
%x = 0
while(%x < %chan[]#)
{
if($window.hasUserFocus(%chan[%x]))
{
%outchan = %con
break;
} else {
%outchan = %con
}
if(%x < %chan[]#)
{
%x = $(%x + 1)
} else {
break;
}
}
%timefront = $str.lefttofirst($1,$char(32))
%timeappend = $str.rightfromlast($1,$char(32))
if($str.matchnocase(\{**\:**\:**\},%timefront))
{
%time = %timefront
%msg = $str.rightfromfirst($1,\})
} else {
if($str.matchnocase(\{**\:**\:**\},%timeappend))
{
%time = %timeappend
%msg = $str.lefttofirst($1,\{)
}
}
if($str.matchnocase(\{**\:**\:**\},%time))
{
echo -n  -w=%con -i=$msgtype(ServerNotice) $k($option(uinttimestampforeground))%time$k [$0] $str.rightfromfirst($1,\})
halt
}
}
event(OnQueryNotice,zncid)
{
%chan = $window.list(channel,$ic)
%con = $window.list(console,$ic)
%x = 0
while(%x < %chan[]#)
{
if($window.hasUserFocus(%chan[%x]))
{
%outchan = %chan[%x]
break;
} else {
%outchan = %con
}
if(%x < %chan[]#)
{
%x = $(%x + 1)
} else {
break;
}
}
%timefront = $str.lefttofirst($3,$char(32))
%timeappend = $str.rightfromlast($3,$char(32))
if($str.matchnocase(\{**\:**\:**\},%timefront))
{
%time = %timefront
%msg = $str.rightfromfirst($3,\})
} else {
if($str.matchnocase(\{**\:**\:**\},%timeappend))
{
%time = %timeappend
%msg = $str.lefttofirst($3,\{)
}
}
if($str.matchnocase(\{**\:**\:**\},%time))
{
echo -n  -w=%outchan -i=$msgtype(QueryNotice) $k($option(uinttimestampforeground))%time$k *$0* $str.rightfromfirst($3,\})
halt
}
}
event(OnQueryMessage,zncid)
{
%timefront = $str.lefttofirst($3,$char(32))
%timeappend = $str.rightfromlast($3,$char(32))
if($str.matchnocase(\{**\:**\:**\},%timefront))
{
%time = %timefront
%msg = $str.rightfromfirst($3,\})
} else {
if($str.matchnocase(\{**\:**\:**\},%timeappend))
{
%time = %timeappend
%msg = $str.lefttofirst($3,\{)
}
}
if($str.matchnocase(\{**\:**\:**\},%time))
{
echo -n -i=$msgtype(ChannelPrivateMessage) $k($option(uinttimestampforeground))%time$k $option(stringextendedprivmsgprefix)%status$0$option(stringextendedprivmsgpostfix)%msg
halt
}
}
event(OnChannelMessage,zncid)
{
if(%Win{$window} > 0)
{
%timefront = $str.lefttofirst($3,$char(32))
%timeappend = $str.rightfromlast($3,$char(32))
if(($option(boolshowchanneluserflaginprivmsgview)) && ($chan.ison($0)) && ($chan.isvoice($0)))%status = $chan.getflag($0)
if($str.matchnocase(\{**\:**\:**\},%timefront))
{
%time = %timefront
%msg = $str.rightfromfirst($3,\})
} else {
if($str.matchnocase(\{**\:**\:**\},%timeappend))
{
%time = %timeappend
%msg = $str.lefttofirst($3,\{)
}
}
if($str.matchnocase(\{**\:**\:**\},%time))
{
                if($str.containsnocase(%msg,$me))
                          {
          echo -n -i=$msgtype(Highlight) $k($option(uinttimestampforeground))%time$k $option(stringextendedprivmsgprefix)%status$0$option(stringextendedprivmsgpostfix) %msg
          halt
                          }else{
                          echo -n -i=$msgtype(ChannelPrivateMessage) $k($option(uinttimestampforeground))%time$k $option(stringextendedprivmsgprefix)%status$0$option(stringextendedprivmsgpostfix) %msg
          halt
                          }
}
}
if($0 == "***")
{
if($3 == "Buffer Playback...")
{
%Win{$window} = 1
}
if($3 == "Playback Complete.")
{
%Win{$window} = 0
}
}
}
event(OnAction,zncid)
{
if(%Win{$window}  > 0)
{
%timefront = $str.lefttofirst($4,$char(32))
%timeappend = $str.rightfromlast($4,$char(32))
if($str.matchnocase(\{**\:**\:**\},%timefront))
{
%time = %timefront
%msg = $str.rightfromfirst($4,\})
} else {
if($str.matchnocase(\{**\:**\:**\},%timeappend))
{
%time = %timeappend
%msg = $str.lefttofirst($4,\{)
}
}
if($chan.ison($0))%status = $chan.getflag($0)
if($str.matchnocase(\{**\:**\:**\},%time))
{
echo -n -i=$msgtype(Action) $k($option(uinttimestampforeground))%time$k $0 %msg
halt
}
}
}
=== mIRC ===
This script '''requires''' these settings for your user:
TimestampFormat = [%H:%M:%S]
AppendTimestamp = false
PrependTimestamp = true
Otherwise you have to adjust the regex pattern in the script that grabs the timestamp.
It handles
* Channel messages
* Savebuff output
* Channel notices
* Channel actions
==== Configuration (optional) ====
If lines are too long to fit the window width they are wrapped so that the wrapped lines will line up after the nick. To disable that behavior, set <tt>%INDENT_LINES</tt> to <tt>$false</tt>.
Nicks will be prefixed with their mode identifier (so "nick" becomes "@nick" for example). To disable this behavior, set <tt>%PREFIX_NICKS</tt> to <tt>$false</tt>.
The beginning and end of buffer playback are marked with the default line separator by default. This can be changed to <tt>NORMAL</tt> to display the usual <tt>*** Buffer Playback.</tt> and <tt>*** Playback Complete</tt> messages or to <tt>NONE</tt> to not show any status message at all.
If you run into problems like all messages being displayed twice because of other <tt>ON TEXT</tt> processing scripts, try to set <tt>%EXTERNAL_RENDERER</tt> to <tt>$false</tt>.
The script also allows the use of spaces.dll to preserve consecutive spaces. To enable it just put <tt>spaces.dll</tt> (http://www.xise.nl/mirc/) into your <tt>Application Data</tt> folder and set <tt>%USE_SPACES_DLL</tt> to <tt>$true</tt>.


==== Script ====
{{Module arguments
Information about loading mIRC scripts can be found [http://chanops.org/faqs/clients/how-to-load-an-mirc-script-into-your-main-mirc-program.html here].
| type = network}}
alias -l config {
  ; Mandatory settings
  var %TIMESTAMP_PATTERN = ^\[(\d\d:\d\d:\d\d)\].*$
  var %PLAYBACK_BEGIN    = Buffer Playback...
  var %PLAYBACK_END      = Playback Complete.
  var %VARIABLE_PREFIX  = gbuffer
  ; Optional settings
  ; Indent wrapped lines
  var %INDENT_LINES = $true
  ; Add the mode prefix to the nick (if possible)
  var %PREFIX_NICKS = $true
  ; Are there other ON TEXT processors in place?
  var %EXTERNAL_RENDERER = $false
  ; Possible values are NORMAL/LINESEP/NONE
  var %STATUS_DISPLAY = LINESEP
  ; Make use of space-preserving spaces.dll
  var %USE_SPACES_DLL = $true
  return $eval( $+( %, $1 ), 2 )
}
alias -l makeNick {
  var %nick = $nick( $1, $2 ).pnick
  if ( ( 0 == $len( %nick ) ) || ( $true != $config( PREFIX_NICKS ) ) ) %nick = $2
  return %nick
}
alias -l handleMessage {
  var %chan = $1
  var %nick = $2
  var %color = $3
  var %pattern = $4
  var %text = $5
  var %pnick = $makeNick( %chan, %nick )
  ; Buffered input
  if ( $true == $eval( $+( %, $config( VARIABLE_PREFIX ), ., $cid, ., %chan, ., playback ), 2 ) ) {
    noop $regex( %text, $config( TIMESTAMP_PATTERN ) ) )
    var %timestamp = $regml( 1 )
    var %params
    if ( $config( INDENT_LINES ) ) %params = $+( i, $calc( $len( %timestamp ) + $len( %pnick ) + 4 ) )
    if ( %nick != $me ) %params = $+( %params, lmr )
    if ( 0 != $len( %params ) ) %params = $+( -, %params )
    if ( %nick == $me ) {
      if ( $true == $config( USE_SPACES_DLL ) ) {
        var %result
        noop $regex( %text, ^.*? (.*)$ )
        noop $regsub( %pattern, &TEXT&, $regml( 1 ), %result )
        noop $regsub( %result , &NICK&, %pnick, %result )
        noop $dll( spaces.dll, echo, $color( own  ) %params $chan %timestamp %result )
      }
      else {
        echo $color( own ) %params $chan %timestamp $replacecs( %pattern, &NICK&, %pnick, &TEXT&, $gettok( %text, 2-, 32 ) )
      }
    }
    else {
      if ( $true == $config( USE_SPACES_DLL ) ) {
        var %result
        noop $regex( %text, ^.*? (.*)$ )
        noop $regsub( $regml( 1 ), /\\/g, \\\\, %result )
        noop $regsub( %pattern, &TEXT&, %result, %result )
        noop $regsub( %result , &NICK&, %pnick, %result )
        noop $dll( spaces.dll, echo, $color( %color ) %params $chan %timestamp %result )
      }
      else {
        echo $color( %color ) %params $chan %timestamp $replacecs( %pattern, &NICK&, %pnick, &TEXT&, $gettok( %text, 2-, 32 ) )
      }
    }
  }
  else {
    ; Current events (optional)
    if ( $true == $config( EXTERNAL_RENDERER ) ) return $false
   
    if ( $true == $config( USE_SPACES_DLL ) ) {
      var %result
      noop $regsub( %pattern, &NICK&, %pnick, %result )
      noop $regsub( %text, /\\/g, \\\\, %text )
      noop $regsub( %result, &TEXT&, %text, %result )
      noop $dll( spaces.dll, echo, $color( %color ) $+( -i, $calc( $len( $timestamp ) + $len( %pnick ) + 5 ), lmrt ) $chan %result )
    }
    else {
      echo $color( %color ) $+( -i, $calc( $len( $timestamp ) + $len( %pnick ) + 4 ), lmrt ) $chan $replacecs( %pattern, &NICK&, %pnick, &TEXT&, %text )
    }
  }
  return $true
}
on ^*:text:*:#:{
  ; Handle savebuff output
  if ( $nick == *savebuff ) {
    var %nick = $gettok( $2, 1, $asc( ! ) )
    var %timestamp = $asctime( $1, $timestampfmt )
    if ( $3 == MODE )    echo $color( mode ) $chan %timestamp * %nick sets mode: $4-
    elseif ( $3 == JOIN ) echo $color( join ) $chan %timestamp * %nick ( $+ $gettok( $2, 2, $asc( ! ) ) $+ ) has joined $chan
    elseif ( $3 == QUIT ) echo $color( quit ) $chan %timestamp * %nick ( $+ $gettok( $2, 2, $asc( ! ) ) $+ ) Quit ( $+ $4- $+ )
    elseif ( $3 == PART ) echo $color( part ) $chan %timestamp * %nick ( $+ $gettok( $2, 2, $asc( ! ) ) $+ ) has left $chan
    elseif ( $3 == NICK ) echo $color( nick ) $chan %timestamp * %nick is now known as $4
    elseif ( $3 == KICK ) echo $color( kick ) $chan %timestamp * $2 was kicked by $gettok( $4, 1, $asc( ! ) ) ( $+ $5- $+ )
    else                  echo $color( erro ) $chan *** UNHANDLED LINE < $+ $1- $+ >
  }
  ; Handle playback state notifications
  elseif ( $nick == *** ) {
    if ( $1- == $config( PLAYBACK_BEGIN ) ) {
      set -e $+( %, $config( VARIABLE_PREFIX ), ., $cid, ., $chan, ., playback ) $true
    }
    elseif ( $1- == $config( PLAYBACK_END ) ) {
      unset $eval( $+( %, $config( VARIABLE_PREFIX ), ., $cid, ., $chan, ., playback ), 1 )
    }
    if ( $config( STATUS_DISPLAY ) == NORMAL ) {
      echo $color( notice ) $chan *** $1-
    }
    elseif ( $config( STATUS_DISPLAY ) == LINESEP ) {
      linesep $chan
    }
  }
  ; Handle usual input
  else {
    var %pattern = ^:.*? :(.*)$
    noop $regex( $rawmsg, %pattern )
    if ( $false == $handleMessage( $chan, $nick, normal, <&NICK&> &TEXT&, $regml( 1 ) ) ) return
  }
  halt
}
on ^*:action:*:#:{
  ;noop $dll( spaces.dll, echo, $chan $rawmsg )
  var %pattern = ^:.*? :\x01ACTION (.*)\x01$
  noop $regex( $rawmsg, %pattern )
  if ( $true == $handleMessage( $chan, $nick, action, * &NICK& &TEXT&, $regml( 1 ) ) ) halt
}
on ^*:notice:*:#:{
  ;noop $dll( spaces.dll, echo, $chan $rawmsg )
  var %pattern = ^:.*? :(.*)$
  noop $regex( $rawmsg, %pattern )
  if ( $true == $handleMessage( $chan, $nick, notice, -&NICK&- &TEXT&, $regml( 1 ) ) ) halt
}


=== irssi ===
=== Commands ===
This script '''requires''' these settings for your user:
This module should work without user interaction; when you can't get your primary nick, it should try to get it for you. However, you can manually change states if necessary.


TimestampFormat = [%H:%M:%S]
The module has two states:
AppendTimestamp = false
* The enabled state: the module is trying to acquire your primary nick. The module will enter this state if you connect to IRC and someone already has your nick. Your nick will be changed to your primary nick after it becomes available, and the module will enter the disabled state.
PrependTimestamp = true
* The disabled state: the module is not trying to acquire your primary nick. The module will enter this state if you change to your primary nick, if you intentionally change your nick from your primary nick to something else (so you can change your nick and not be forced back to your primary nick), or if you are prevented from changing nick by a channel mode or ban.


Otherwise you have to adjust the regex pattern in the script that grabs the timestamp.
; <code>/msg *keepnick enable</code>
: Manually enters the enabled state


Download the script from: http://cba.si/stuff/znc_timestamp.pl
; <code>/msg *keepnick disable</code>
: Manually enters the disabled state


Put it into ~/.irssi/scripts, then '''/script load znc_timestamp''' .
; <code>/msg *keepnick state</code>
: Tells you what state the module is in; whether the module is currently trying to change your nick or not.


=== WeeChat ===
; <code>Help <?search></code>
* [http://www.weechat.org/files/scripts/unofficial/znc-playback.py znc-playback.py]
: Shows this help, optionally search for word/phrase in help output.

Latest revision as of 02:10, 27 December 2018

This module tries to get your primary nick, as specified in the ZNC config. Especially useful on IRC networks that do not have services like NickServ to reserve your name and prevent others from taking it.

Usage

Arguments

This network module takes no arguments.

Read loading modules to learn more about loading modules.

Commands

This module should work without user interaction; when you can't get your primary nick, it should try to get it for you. However, you can manually change states if necessary.

The module has two states:

  • The enabled state: the module is trying to acquire your primary nick. The module will enter this state if you connect to IRC and someone already has your nick. Your nick will be changed to your primary nick after it becomes available, and the module will enter the disabled state.
  • The disabled state: the module is not trying to acquire your primary nick. The module will enter this state if you change to your primary nick, if you intentionally change your nick from your primary nick to something else (so you can change your nick and not be forced back to your primary nick), or if you are prevented from changing nick by a channel mode or ban.
/msg *keepnick enable
Manually enters the enabled state
/msg *keepnick disable
Manually enters the disabled state
/msg *keepnick state
Tells you what state the module is in; whether the module is currently trying to change your nick or not.
Help <?search>
Shows this help, optionally search for word/phrase in help output.