source: nick.c @ 94d5da9c

Last change on this file since 94d5da9c was 6f0ea57, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-07-17T14:37:33Z

Making nick_format a tiny bit more complicated: Allow truncating a variable
to a certain length.

  • Property mode set to 100644
File size: 9.4 KB
Line 
1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2010 Wilmer van der Gaast and others                *
5  \********************************************************************/
6
7/* Some stuff to fetch, save and handle nicknames for your buddies      */
8
9/*
10  This program is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  GNU General Public License for more details.
19
20  You should have received a copy of the GNU General Public License with
21  the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL;
22  if not, write to the Free Software Foundation, Inc., 59 Temple Place,
23  Suite 330, Boston, MA  02111-1307  USA
24*/
25
26#define BITLBEE_CORE
27#include "bitlbee.h"
28
29/* Character maps, _lc_[x] == _uc_[x] (but uppercase), according to the RFC's.
30   With one difference, we allow dashes. These are used to do uc/lc conversions
31   and strip invalid chars. */
32static char *nick_lc_chars = "0123456789abcdefghijklmnopqrstuvwxyz{}^`-_|";
33static char *nick_uc_chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ[]~`-_\\";
34
35/* Store handles in lower case and strip spaces, because AIM is braindead. */
36static char *clean_handle( const char *orig )
37{
38        char *new = g_malloc( strlen( orig ) + 1 );
39        int i = 0;
40       
41        do {
42                if (*orig != ' ')
43                        new[i++] = tolower( *orig );
44        }
45        while (*(orig++));
46       
47        return new;
48}
49
50void nick_set_raw( account_t *acc, const char *handle, const char *nick )
51{
52        char *store_handle, *store_nick = g_malloc( MAX_NICK_LENGTH + 1 );
53       
54        store_handle = clean_handle( handle );
55        store_nick[MAX_NICK_LENGTH] = '\0';
56        strncpy( store_nick, nick, MAX_NICK_LENGTH );
57        nick_strip( store_nick );
58       
59        g_hash_table_replace( acc->nicks, store_handle, store_nick );
60}
61
62void nick_set( bee_user_t *bu, const char *nick )
63{
64        nick_set_raw( bu->ic->acc, bu->handle, nick );
65}
66
67char *nick_get( bee_user_t *bu )
68{
69        static char nick[MAX_NICK_LENGTH+1];
70        char *store_handle, *found_nick;
71       
72        memset( nick, 0, MAX_NICK_LENGTH + 1 );
73       
74        store_handle = clean_handle( bu->handle );
75        /* Find out if we stored a nick for this person already. If not, try
76           to generate a sane nick automatically. */
77        if( ( found_nick = g_hash_table_lookup( bu->ic->acc->nicks, store_handle ) ) )
78        {
79                strncpy( nick, found_nick, MAX_NICK_LENGTH );
80        }
81        else if( ( found_nick = nick_gen( bu ) ) )
82        {
83                strncpy( nick, found_nick, MAX_NICK_LENGTH );
84                g_free( found_nick );
85        }
86        else
87        {
88                /* Keep this fallback since nick_gen() can return NULL in some cases. */
89                char *s;
90               
91                g_snprintf( nick, MAX_NICK_LENGTH, "%s", bu->handle );
92                if( ( s = strchr( nick, '@' ) ) )
93                        while( *s )
94                                *(s++) = 0;
95               
96                nick_strip( nick );
97                if( set_getbool( &bu->bee->set, "lcnicks" ) )
98                        nick_lc( nick );
99        }
100        g_free( store_handle );
101       
102        /* Make sure the nick doesn't collide with an existing one by adding
103           underscores and that kind of stuff, if necessary. */
104        nick_dedupe( bu, nick );
105       
106        return nick;
107}
108
109char *nick_gen( bee_user_t *bu )
110{
111        gboolean ok = FALSE; /* Set to true once the nick contains something unique. */
112        GString *ret = g_string_new( "" );
113        char *fmt = set_getstr( &bu->ic->acc->set, "nick_format" ) ? :
114                    set_getstr( &bu->bee->set, "nick_format" );
115       
116        while( fmt && *fmt && ret->len < MAX_NICK_LENGTH )
117        {
118                char *part, chop = '\0', *asc = NULL;
119                int len = MAX_NICK_LENGTH;
120               
121                if( *fmt != '%' )
122                {
123                        g_string_append_c( ret, *fmt );
124                        fmt ++;
125                        continue;
126                }
127               
128                fmt ++;
129                while( *fmt )
130                {
131                        /* -char means chop off everything from char */
132                        if( *fmt == '-' )
133                        {
134                                chop = fmt[1];
135                                if( chop == '\0' )
136                                        return NULL;
137                                fmt += 2;
138                        }
139                        else if( isdigit( *fmt ) )
140                        {
141                                len = 0;
142                                /* Grab a number. */
143                                while( isdigit( *fmt ) )
144                                        len = len * 10 + ( *(fmt++) - '0' );
145                        }
146                        else if( g_strncasecmp( fmt, "nick", 4 ) == 0 )
147                        {
148                                part = bu->nick ? : bu->handle;
149                                fmt += 4;
150                                ok |= TRUE;
151                                break;
152                        }
153                        else if( g_strncasecmp( fmt, "handle", 6 ) == 0 )
154                        {
155                                part = bu->handle;
156                                fmt += 6;
157                                ok |= TRUE;
158                                break;
159                        }
160                        else if( g_strncasecmp( fmt, "full_name", 9 ) == 0 )
161                        {
162                                part = bu->fullname;
163                                fmt += 9;
164                                ok |= part && *part;
165                                break;
166                        }
167                        else if( g_strncasecmp( fmt, "first_name", 10 ) == 0 )
168                        {
169                                part = bu->fullname;
170                                fmt += 10;
171                                ok |= part && *part;
172                                chop = ' ';
173                                break;
174                        }
175                        else if( g_strncasecmp( fmt, "group", 5 ) == 0 )
176                        {
177                                part = bu->group ? bu->group->name : NULL;
178                                fmt += 5;
179                                break;
180                        }
181                        else
182                        {
183                                return NULL;
184                        }
185                }
186               
187                /* Credits to Josay_ in #bitlbee for this idea. //TRANSLIT
188                   should do lossy/approximate conversions, so letters with
189                   accents don't just get stripped. Note that it depends on
190                   LC_CTYPE being set to something other than C/POSIX. */
191                if( part )
192                        part = asc = g_convert( part, -1, "ASCII//TRANSLIT//IGNORE",
193                                                "UTF-8", NULL, NULL, NULL );
194               
195                if( ret->len == 0 && part && isdigit( *part ) )
196                        g_string_append_c( ret, '_' );
197               
198                while( part && *part && *part != chop && len > 0 )
199                {
200                        if( strchr( nick_lc_chars, *part ) ||
201                            strchr( nick_uc_chars, *part ) )
202                                g_string_append_c( ret, *part );
203                       
204                        part ++;
205                        len --;
206                }
207                g_free( asc );
208        }
209       
210        /* This returns NULL if the nick is empty or otherwise not ok. */
211        return g_string_free( ret, ret->len == 0 || !ok );
212}
213
214void nick_dedupe( bee_user_t *bu, char nick[MAX_NICK_LENGTH+1] )
215{
216        irc_t *irc = (irc_t*) bu->bee->ui_data;
217        int inf_protection = 256;
218        irc_user_t *iu;
219       
220        /* Now, find out if the nick is already in use at the moment, and make
221           subtle changes to make it unique. */
222        while( !nick_ok( nick ) ||
223               ( ( iu = irc_user_by_name( irc, nick ) ) && iu->bu != bu ) )
224        {
225                if( strlen( nick ) < ( MAX_NICK_LENGTH - 1 ) )
226                {
227                        nick[strlen(nick)+1] = 0;
228                        nick[strlen(nick)] = '_';
229                }
230                else
231                {
232                        nick[0] ++;
233                }
234               
235                if( inf_protection-- == 0 )
236                {
237                        int i;
238                       
239                        irc_usermsg( irc, "Warning: Almost had an infinite loop in nick_get()! "
240                                          "This used to be a fatal BitlBee bug, but we tried to fix it. "
241                                          "This message should *never* appear anymore. "
242                                          "If it does, please *do* send us a bug report! "
243                                          "Please send all the following lines in your report:" );
244                       
245                        irc_usermsg( irc, "Trying to get a sane nick for handle %s", bu->handle );
246                        for( i = 0; i < MAX_NICK_LENGTH; i ++ )
247                                irc_usermsg( irc, "Char %d: %c/%d", i, nick[i], nick[i] );
248                       
249                        irc_usermsg( irc, "FAILED. Returning an insane nick now. Things might break. "
250                                          "Good luck, and please don't forget to paste the lines up here "
251                                          "in #bitlbee on OFTC or in a mail to wilmer@gaast.net" );
252                       
253                        g_snprintf( nick, MAX_NICK_LENGTH + 1, "xx%x", rand() );
254                       
255                        break;
256                }
257        }
258}
259
260/* Just check if there is a nickname set for this buddy or if we'd have to
261   generate one. */
262int nick_saved( bee_user_t *bu )
263{
264        char *store_handle, *found;
265       
266        store_handle = clean_handle( bu->handle );
267        found = g_hash_table_lookup( bu->ic->acc->nicks, store_handle );
268        g_free( store_handle );
269       
270        return found != NULL;
271}
272
273void nick_del( bee_user_t *bu )
274{
275        g_hash_table_remove( bu->ic->acc->nicks, bu->handle );
276}
277
278
279void nick_strip( char *nick )
280{
281        int i, j;
282       
283        for( i = j = 0; nick[i] && j < MAX_NICK_LENGTH; i++ )
284        {
285                if( strchr( nick_lc_chars, nick[i] ) || 
286                    strchr( nick_uc_chars, nick[i] ) )
287                {
288                        nick[j] = nick[i];
289                        j++;
290                }
291        }
292        if( isdigit( nick[0] ) )
293        {
294                char *orig;
295               
296                orig = g_strdup( nick );
297                g_snprintf( nick, MAX_NICK_LENGTH, "_%s", orig );
298                g_free( orig );
299                j ++;
300        }
301        while( j <= MAX_NICK_LENGTH )
302                nick[j++] = '\0';
303}
304
305int nick_ok( const char *nick )
306{
307        const char *s;
308       
309        /* Empty/long nicks are not allowed, nor numbers at [0] */
310        if( !*nick || isdigit( nick[0] ) || strlen( nick ) > MAX_NICK_LENGTH )
311                return( 0 );
312       
313        for( s = nick; *s; s ++ )
314                if( !strchr( nick_lc_chars, *s ) && !strchr( nick_uc_chars, *s ) )
315                        return( 0 );
316       
317        return( 1 );
318}
319
320int nick_lc( char *nick )
321{
322        static char tab[128] = { 0 };
323        int i;
324       
325        if( tab['A'] == 0 )
326                for( i = 0; nick_lc_chars[i]; i ++ )
327                {
328                        tab[(int)nick_uc_chars[i]] = nick_lc_chars[i];
329                        tab[(int)nick_lc_chars[i]] = nick_lc_chars[i];
330                }
331       
332        for( i = 0; nick[i]; i ++ )
333        {
334                if( !tab[(int)nick[i]] )
335                        return( 0 );
336               
337                nick[i] = tab[(int)nick[i]];
338        }
339       
340        return( 1 );
341}
342
343int nick_uc( char *nick )
344{
345        static char tab[128] = { 0 };
346        int i;
347       
348        if( tab['A'] == 0 )
349                for( i = 0; nick_lc_chars[i]; i ++ )
350                {
351                        tab[(int)nick_uc_chars[i]] = nick_uc_chars[i];
352                        tab[(int)nick_lc_chars[i]] = nick_uc_chars[i];
353                }
354       
355        for( i = 0; nick[i]; i ++ )
356        {
357                if( !tab[(int)nick[i]] )
358                        return( 0 );
359               
360                nick[i] = tab[(int)nick[i]];
361        }
362       
363        return( 1 );
364}
365
366int nick_cmp( const char *a, const char *b )
367{
368        char aa[1024] = "", bb[1024] = "";
369       
370        strncpy( aa, a, sizeof( aa ) - 1 );
371        strncpy( bb, b, sizeof( bb ) - 1 );
372        if( nick_lc( aa ) && nick_lc( bb ) )
373        {
374                return( strcmp( aa, bb ) );
375        }
376        else
377        {
378                return( -1 );   /* Hmm... Not a clear answer.. :-/ */
379        }
380}
381
382char *nick_dup( const char *nick )
383{
384        return g_strndup( nick, MAX_NICK_LENGTH );
385}
Note: See TracBrowser for help on using the repository browser.