smb: remove dummy define (this is already done (properly) in vlc_common.h.
[vlc.git] / modules / access / smb.c
1 /*****************************************************************************
2  * smb.c: SMB input module
3  *****************************************************************************
4  * Copyright (C) 2001-2009 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include <vlc_charset.h>
33 #include <vlc_plugin.h>
34 #include <vlc_access.h>
35
36 #ifdef WIN32
37 #   ifdef HAVE_FCNTL_H
38 #       include <fcntl.h>
39 #   endif
40 #   ifdef HAVE_SYS_STAT_H
41 #       include <sys/stat.h>
42 #   endif
43 #   include <io.h>
44 #   define smbc_open(a,b,c) utf8_open(a,b,c)
45 #   define smbc_fstat(a,b) _fstati64(a,b)
46 #   define smbc_read read
47 #   define smbc_lseek _lseeki64
48 #   define smbc_close close
49 #else
50 #   include <libsmbclient.h>
51 #endif
52
53 #include <errno.h>
54
55 /*****************************************************************************
56  * Module descriptor
57  *****************************************************************************/
58 static int  Open ( vlc_object_t * );
59 static void Close( vlc_object_t * );
60
61 #define CACHING_TEXT N_("Caching value in ms")
62 #define CACHING_LONGTEXT N_( \
63     "Caching value for SMB streams. This " \
64     "value should be set in milliseconds." )
65 #define USER_TEXT N_("SMB user name")
66 #define USER_LONGTEXT N_("User name that will " \
67     "be used for the connection.")
68 #define PASS_TEXT N_("SMB password")
69 #define PASS_LONGTEXT N_("Password that will be " \
70     "used for the connection.")
71 #define DOMAIN_TEXT N_("SMB domain")
72 #define DOMAIN_LONGTEXT N_("Domain/Workgroup that " \
73     "will be used for the connection.")
74
75 vlc_module_begin ()
76     set_shortname( "SMB" )
77     set_description( N_("SMB input") )
78     set_capability( "access", 0 )
79     set_category( CAT_INPUT )
80     set_subcategory( SUBCAT_INPUT_ACCESS )
81     add_integer( "smb-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
82                  CACHING_TEXT, CACHING_LONGTEXT, true )
83         change_safe()
84     add_string( "smb-user", NULL, NULL, USER_TEXT, USER_LONGTEXT,
85                 false )
86     add_password( "smb-pwd", NULL, NULL, PASS_TEXT,
87                   PASS_LONGTEXT, false )
88     add_string( "smb-domain", NULL, NULL, DOMAIN_TEXT,
89                 DOMAIN_LONGTEXT, false )
90     add_shortcut( "smb" )
91     set_callbacks( Open, Close )
92 vlc_module_end ()
93
94 /*****************************************************************************
95  * Local prototypes
96  *****************************************************************************/
97 static ssize_t Read( access_t *, uint8_t *, size_t );
98 static int Seek( access_t *, int64_t );
99 static int Control( access_t *, int, va_list );
100
101 struct access_sys_t
102 {
103     int i_smb;
104 };
105
106 #ifdef WIN32
107 static void Win32AddConnection( access_t *, char *, char *, char *, char * );
108 #else
109 static void smb_auth( const char *srv, const char *shr, char *wg, int wglen,
110                       char *un, int unlen, char *pw, int pwlen )
111 {
112     //wglen = unlen = pwlen = 0;
113 }
114 #endif
115
116 /****************************************************************************
117  * Open: connect to smb server and ask for file
118  ****************************************************************************/
119 static int Open( vlc_object_t *p_this )
120 {
121     access_t     *p_access = (access_t*)p_this;
122     access_sys_t *p_sys;
123     struct stat  filestat;
124     char         *psz_path, *psz_uri;
125     char         *psz_user = NULL, *psz_pwd = NULL, *psz_domain = NULL;
126     int          i_ret;
127     int          i_smb;
128
129     /* Parse input URI
130      * [[[domain;]user[:password@]]server[/share[/path[/file]]]] */
131     psz_path = strchr( p_access->psz_path, '/' );
132     if( !psz_path )
133     {
134         msg_Err( p_access, "invalid SMB URI: smb://%s", psz_path );
135         return VLC_EGENERIC;
136     }
137     else
138     {
139         char *psz_tmp = strdup( p_access->psz_path );
140         char *psz_parser;
141
142         psz_tmp[ psz_path - p_access->psz_path ] = 0;
143         psz_path = p_access->psz_path;
144         psz_parser = strchr( psz_tmp, '@' );
145         if( psz_parser )
146         {
147             /* User info is there */
148             *psz_parser = 0;
149             psz_path = p_access->psz_path + (psz_parser - psz_tmp) + 1;
150
151             psz_parser = strchr( psz_tmp, ':' );
152             if( psz_parser )
153             {
154                 /* Password found */
155                 psz_pwd = strdup( psz_parser+1 );
156                 *psz_parser = 0;
157             }
158
159             psz_parser = strchr( psz_tmp, ';' );
160             if( psz_parser )
161             {
162                 /* Domain found */
163                 *psz_parser = 0; psz_parser++;
164                 psz_domain = strdup( psz_tmp );
165             }
166             else psz_parser = psz_tmp;
167
168             psz_user = strdup( psz_parser );
169         }
170
171         free( psz_tmp );
172     }
173
174     /* Build an SMB URI
175      * smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]] */
176
177     if( !psz_user ) psz_user = var_CreateGetString( p_access, "smb-user" );
178     if( psz_user && !*psz_user ) { free( psz_user ); psz_user = NULL; }
179     if( !psz_pwd ) psz_pwd = var_CreateGetString( p_access, "smb-pwd" );
180     if( psz_pwd && !*psz_pwd ) { free( psz_pwd ); psz_pwd = NULL; }
181     if( !psz_domain ) psz_domain = var_CreateGetString( p_access, "smb-domain" );
182     if( psz_domain && !*psz_domain ) { free( psz_domain ); psz_domain = NULL; }
183
184 #ifdef WIN32
185     if( psz_user )
186         Win32AddConnection( p_access, psz_path, psz_user, psz_pwd, psz_domain);
187     i_ret = asprintf( &psz_uri, "//%s", psz_path );
188 #else
189     if( psz_user )
190         i_ret = asprintf( &psz_uri, "smb://%s%s%s%s%s@%s",
191                           psz_domain ? psz_domain : "", psz_domain ? ";" : "",
192                           psz_user, psz_pwd ? ":" : "",
193                           psz_pwd ? psz_pwd : "", psz_path );
194     else
195         i_ret = asprintf( &psz_uri, "smb://%s", psz_path );
196 #endif
197
198     free( psz_user );
199     free( psz_pwd );
200     free( psz_domain );
201
202     if( i_ret == -1 )
203         return VLC_ENOMEM;
204
205 #ifndef WIN32
206     if( smbc_init( smb_auth, 0 ) )
207     {
208         free( psz_uri );
209         return VLC_EGENERIC;
210     }
211 #endif
212
213 /*
214 ** some version of glibc defines open as a macro, causing havoc
215 ** with other macros using 'open' under the hood, such as the
216 ** following one:
217 */
218 #if defined(smbc_open) && defined(open)
219 # undef open
220 #endif
221     if( (i_smb = smbc_open( psz_uri, O_RDONLY, 0 )) < 0 )
222     {
223         msg_Err( p_access, "open failed for '%s' (%m)", p_access->psz_path );
224         free( psz_uri );
225         return VLC_EGENERIC;
226     }
227
228     /* Init p_access */
229     STANDARD_READ_ACCESS_INIT;
230
231     i_ret = smbc_fstat( i_smb, &filestat );
232     if( i_ret )
233     {
234         errno = i_ret;
235         msg_Err( p_access, "stat failed (%m)" );
236     }
237     else
238         p_access->info.i_size = filestat.st_size;
239
240     free( psz_uri );
241
242     p_sys->i_smb = i_smb;
243
244     /* Update default_pts to a suitable value for smb access */
245     var_Create( p_access, "smb-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
246
247     return VLC_SUCCESS;
248 }
249
250 /*****************************************************************************
251  * Close: free unused data structures
252  *****************************************************************************/
253 static void Close( vlc_object_t *p_this )
254 {
255     access_t     *p_access = (access_t*)p_this;
256     access_sys_t *p_sys = p_access->p_sys;
257
258     smbc_close( p_sys->i_smb );
259     free( p_sys );
260 }
261
262 /*****************************************************************************
263  * Seek: try to go at the right place
264  *****************************************************************************/
265 static int Seek( access_t *p_access, int64_t i_pos )
266 {
267     access_sys_t *p_sys = p_access->p_sys;
268     int64_t      i_ret;
269
270     if( i_pos < 0 ) return VLC_EGENERIC;
271
272     msg_Dbg( p_access, "seeking to %"PRId64, i_pos );
273
274     i_ret = smbc_lseek( p_sys->i_smb, i_pos, SEEK_SET );
275     if( i_ret == -1 )
276     {
277         msg_Err( p_access, "seek failed (%m)" );
278         return VLC_EGENERIC;
279     }
280
281     p_access->info.b_eof = false;
282     p_access->info.i_pos = i_ret;
283
284     return VLC_SUCCESS;
285 }
286
287 /*****************************************************************************
288  * Read:
289  *****************************************************************************/
290 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
291 {
292     access_sys_t *p_sys = p_access->p_sys;
293     int i_read;
294
295     if( p_access->info.b_eof ) return 0;
296
297     i_read = smbc_read( p_sys->i_smb, p_buffer, i_len );
298     if( i_read < 0 )
299     {
300         msg_Err( p_access, "read failed (%m)" );
301         return -1;
302     }
303
304     if( i_read == 0 ) p_access->info.b_eof = true;
305     else if( i_read > 0 ) p_access->info.i_pos += i_read;
306
307     return i_read;
308 }
309
310 /*****************************************************************************
311  * Control:
312  *****************************************************************************/
313 static int Control( access_t *p_access, int i_query, va_list args )
314 {
315     bool        *pb_bool;
316     int64_t     *pi_64;
317
318     switch( i_query )
319     {
320     case ACCESS_CAN_SEEK:
321     case ACCESS_CAN_FASTSEEK:
322     case ACCESS_CAN_PAUSE:
323     case ACCESS_CAN_CONTROL_PACE:
324         pb_bool = (bool*)va_arg( args, bool* );
325         *pb_bool = true;
326         break;
327
328     case ACCESS_GET_PTS_DELAY:
329         pi_64 = (int64_t*)va_arg( args, int64_t * );
330         *pi_64 = (int64_t)var_GetInteger( p_access, "smb-caching" ) * 1000;
331         break;
332
333     case ACCESS_SET_PAUSE_STATE:
334         /* Nothing to do */
335         break;
336
337     case ACCESS_GET_TITLE_INFO:
338     case ACCESS_SET_TITLE:
339     case ACCESS_SET_SEEKPOINT:
340     case ACCESS_SET_PRIVATE_ID_STATE:
341     case ACCESS_GET_CONTENT_TYPE:
342         return VLC_EGENERIC;
343
344     default:
345         msg_Warn( p_access, "unimplemented query in control" );
346         return VLC_EGENERIC;
347
348     }
349
350     return VLC_SUCCESS;
351 }
352
353 #ifdef WIN32
354 static void Win32AddConnection( access_t *p_access, char *psz_path,
355                                 char *psz_user, char *psz_pwd,
356                                 char *psz_domain )
357 {
358     DWORD (*OurWNetAddConnection2)( LPNETRESOURCE, LPCTSTR, LPCTSTR, DWORD );
359     char psz_remote[MAX_PATH], psz_server[MAX_PATH], psz_share[MAX_PATH];
360     NETRESOURCE net_resource;
361     DWORD i_result;
362     char *psz_parser;
363     VLC_UNUSED( psz_domain );
364
365     HINSTANCE hdll = LoadLibrary(_T("MPR.DLL"));
366     if( !hdll )
367     {
368         msg_Warn( p_access, "couldn't load mpr.dll" );
369         return;
370     }
371
372     OurWNetAddConnection2 =
373       (void *)GetProcAddress( hdll, _T("WNetAddConnection2A") );
374     if( !OurWNetAddConnection2 )
375     {
376         msg_Warn( p_access, "couldn't find WNetAddConnection2 in mpr.dll" );
377         return;
378     }
379
380     memset( &net_resource, 0, sizeof(net_resource) );
381     net_resource.dwType = RESOURCETYPE_DISK;
382
383     /* Find out server and share names */
384     strlcpy( psz_server, psz_path, sizeof( psz_server ) );
385     psz_share[0] = 0;
386     psz_parser = strchr( psz_path, '/' );
387     if( psz_parser )
388     {
389         char *psz_parser2 = strchr( ++psz_parser, '/' );
390         if( psz_parser2 )
391             strlcpy( psz_share, psz_parser, sizeof( psz_share ) );
392    }
393
394     snprintf( psz_remote, sizeof( psz_remote ), "\\\\%s\\%s", psz_server, psz_share );
395     net_resource.lpRemoteName = psz_remote;
396
397     i_result = OurWNetAddConnection2( &net_resource, psz_pwd, psz_user, 0 );
398
399     if( i_result != NO_ERROR )
400     {
401         msg_Dbg( p_access, "connected to %s", psz_remote );
402     }
403     else if( i_result != ERROR_ALREADY_ASSIGNED &&
404              i_result != ERROR_DEVICE_ALREADY_REMEMBERED )
405     {
406         msg_Dbg( p_access, "already connected to %s", psz_remote );
407     }
408     else
409     {
410         msg_Dbg( p_access, "failed to connect to %s", psz_remote );
411     }
412
413     FreeLibrary( hdll );
414 }
415 #endif // WIN32