src/vfs/sftpfs/internal.c

   1 /* Virtual File System: SFTP file system.
   2    The internal functions
   3
   4    Copyright (C) 2011
   5    The Free Software Foundation, Inc.
   6
   7    Written by:
   8    Ilia Maslakov <il.smind@gmail.com>, 2011
   9    Slava Zanko <slavazanko@gmail.com>, 2011, 2012
  10
  11    This file is part of the Midnight Commander.
  12
  13    The Midnight Commander is free software: you can redistribute it
  14    and/or modify it under the terms of the GNU General Public License as
  15    published by the Free Software Foundation, either version 3 of the License,
  16    or (at your option) any later version.
  17
  18    The Midnight Commander is distributed in the hope that it will be useful,
  19    but WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21    GNU General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public License
  24    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  25  */
  26
  27 #include <config.h>
  28 #include <errno.h>
  29
  30 #include "lib/global.h"
  31
  32 #include "internal.h"
  33
  34 /*** global variables ****************************************************************************/
  35
  36 GString *sftpfs_filename_buffer = NULL;
  37
  38 /*** file scope macro definitions ****************************************************************/
  39
  40 /*** file scope type declarations ****************************************************************/
  41
  42 /*** file scope variables ************************************************************************/
  43
  44 /*** file scope functions ************************************************************************/
  45 /* --------------------------------------------------------------------------------------------- */
  46
  47 /* --------------------------------------------------------------------------------------------- */
  48 /*** public functions ****************************************************************************/
  49 /* --------------------------------------------------------------------------------------------- */
  50 /**
  51  * Show error message (if error have raised) and cleanup GError object.
  52  *
  53  * @param error pointer to object contains error message
  54  * @return TRUE if error message was printed, FALSE otherwise
  55  */
  56
  57 gboolean
  58 sftpfs_show_error (GError ** error)
  59 {
  60     if (error == NULL || *error == NULL)
  61         return FALSE;
  62
  63     vfs_print_message ("(%d) %s", (*error)->code, (*error)->message);
  64     g_error_free (*error);
  65     *error = NULL;
  66     return TRUE;
  67 }
  68
  69 /* --------------------------------------------------------------------------------------------- */
  70 /**
  71  * Convert libssh error to GError object.
  72  *
  73  * @param super_data   extra data for SFTP connection
  74  * @param libssh_errno errno from libssh
  75  * @param error        pointer to the error object
  76  */
  77
  78 void
  79 sftpfs_ssherror_to_gliberror (sftpfs_super_data_t * super_data, int libssh_errno, GError ** error)
  80 {
  81     char *err = NULL;
  82     int err_len;
  83
  84     g_return_if_fail (error == NULL || *error == NULL);
  85
  86     libssh2_session_last_error (super_data->session, &err, &err_len, 1);
  87     g_set_error (error, MC_ERROR, libssh_errno, "%s", err);
  88     g_free (err);
  89 }
  90
  91 /* --------------------------------------------------------------------------------------------- */
  92 /**
  93  * Fix filename for SFTP operations: add leading slash to file name.
  94  *
  95  * @param file_name file name
  96  * @return newly allocated string contains the file name with leading slash
  97  */
  98
  99 const char *
 100 sftpfs_fix_filename (const char *file_name)
 101 {
 102     g_string_printf (sftpfs_filename_buffer, "%c%s", PATH_SEP, file_name);
 103     return sftpfs_filename_buffer->str;
 104 }
 105
 106 /* --------------------------------------------------------------------------------------------- */
 107 /**
 108  * Awaiting for any activity on socket.
 109  *
 110  * @param super_data extra data for SFTP connection
 111  * @param error      unused
 112  * @return 0 if sucess, negative value otherwise
 113  */
 114
 115 int
 116 sftpfs_waitsocket (sftpfs_super_data_t * super_data, GError ** error)
 117 {
 118     struct timeval timeout = { 10, 0 };
 119     fd_set fd;
 120     fd_set *writefd = NULL;
 121     fd_set *readfd = NULL;
 122     int dir;
 123
 124     (void) error;
 125
 126     FD_ZERO (&fd);
 127     FD_SET (super_data->socket_handle, &fd);
 128
 129     /* now make sure we wait in the correct direction */
 130     dir = libssh2_session_block_directions (super_data->session);
 131
 132     if ((dir & LIBSSH2_SESSION_BLOCK_INBOUND) != 0)
 133         readfd = &fd;
 134
 135     if ((dir & LIBSSH2_SESSION_BLOCK_OUTBOUND) != 0)
 136         writefd = &fd;
 137
 138     return select (super_data->socket_handle + 1, readfd, writefd, NULL, &timeout);
 139 }
 140
 141 /* --------------------------------------------------------------------------------------------- */
 142 /**
 143  * Getting information about a symbolic link.
 144  *
 145  * @param vpath path to file, directory or symbolic link
 146  * @param buf   buffer for store stat-info
 147  * @param error pointer to error object
 148  * @return 0 if sucess, negative value otherwise
 149  */
 150
 151 int
 152 sftpfs_lstat (const vfs_path_t * vpath, struct stat *buf, GError ** error)
 153 {
 154     struct vfs_s_super *super;
 155     sftpfs_super_data_t *super_data;
 156     LIBSSH2_SFTP_ATTRIBUTES attrs;
 157     int res;
 158     const vfs_path_element_t *path_element;
 159
 160     path_element = vfs_path_get_by_index (vpath, -1);
 161
 162     if (vfs_s_get_path (vpath, &super, 0) == NULL)
 163         return -1;
 164
 165     if (super == NULL)
 166         return -1;
 167
 168     super_data = (sftpfs_super_data_t *) super->data;
 169     if (super_data->sftp_session == NULL)
 170         return -1;
 171
 172     do
 173     {
 174         const char *fixfname;
 175
 176         fixfname = sftpfs_fix_filename (path_element->path);
 177
 178         res = libssh2_sftp_stat_ex (super_data->sftp_session, fixfname,
 179                                     sftpfs_filename_buffer->len, LIBSSH2_SFTP_LSTAT, &attrs);
 180         if (res >= 0)
 181             break;
 182
 183         if (res != LIBSSH2_ERROR_EAGAIN)
 184         {
 185             sftpfs_ssherror_to_gliberror (super_data, res, error);
 186             return -1;
 187         }
 188
 189         sftpfs_waitsocket (super_data, error);
 190         if (error != NULL && *error != NULL)
 191             return -1;
 192     }
 193     while (res == LIBSSH2_ERROR_EAGAIN);
 194
 195     if ((attrs.flags & LIBSSH2_SFTP_ATTR_UIDGID) != 0)
 196     {
 197         buf->st_uid = attrs.uid;
 198         buf->st_gid = attrs.gid;
 199     }
 200
 201     if ((attrs.flags & LIBSSH2_SFTP_ATTR_ACMODTIME) != 0)
 202     {
 203         buf->st_atime = attrs.atime;
 204         buf->st_mtime = attrs.mtime;
 205         buf->st_ctime = attrs.mtime;
 206     }
 207
 208     if ((attrs.flags & LIBSSH2_SFTP_ATTR_SIZE) != 0)
 209         buf->st_size = attrs.filesize;
 210
 211     if ((attrs.flags & LIBSSH2_SFTP_ATTR_PERMISSIONS) != 0)
 212         buf->st_mode = attrs.permissions;
 213
 214     return 0;
 215 }
 216
 217 /* --------------------------------------------------------------------------------------------- */
 218 /**
 219  * Getting information about a file or directory.
 220  *
 221  * @param vpath path to file or directory
 222  * @param buf   buffer for store stat-info
 223  * @param error pointer to error object
 224  * @return 0 if sucess, negative value otherwise
 225  */
 226
 227 int
 228 sftpfs_stat (const vfs_path_t * vpath, struct stat *buf, GError ** error)
 229 {
 230     struct vfs_s_super *super;
 231     sftpfs_super_data_t *super_data;
 232     LIBSSH2_SFTP_ATTRIBUTES attrs;
 233     int res;
 234     const vfs_path_element_t *path_element;
 235
 236     path_element = vfs_path_get_by_index (vpath, -1);
 237
 238     if (vfs_s_get_path (vpath, &super, 0) == NULL)
 239         return -1;
 240
 241     if (super == NULL)
 242         return -1;
 243
 244     super_data = (sftpfs_super_data_t *) super->data;
 245     if (super_data->sftp_session == NULL)
 246         return -1;
 247
 248     do
 249     {
 250         const char *fixfname;
 251
 252         fixfname = sftpfs_fix_filename (path_element->path);
 253
 254         res =
 255             libssh2_sftp_stat_ex (super_data->sftp_session,
 256                                   fixfname, sftpfs_filename_buffer->len, LIBSSH2_SFTP_STAT, &attrs);
 257         if (res >= 0)
 258             break;
 259
 260         if (res != LIBSSH2_ERROR_EAGAIN)
 261         {
 262             sftpfs_ssherror_to_gliberror (super_data, res, error);
 263             return -1;
 264         }
 265
 266         sftpfs_waitsocket (super_data, error);
 267         if (error != NULL && *error != NULL)
 268             return -1;
 269     }
 270     while (res == LIBSSH2_ERROR_EAGAIN);
 271
 272     buf->st_nlink = 1;
 273     if ((attrs.flags & LIBSSH2_SFTP_ATTR_UIDGID) != 0)
 274     {
 275         buf->st_uid = attrs.uid;
 276         buf->st_gid = attrs.gid;
 277     }
 278
 279     if ((attrs.flags & LIBSSH2_SFTP_ATTR_ACMODTIME) != 0)
 280     {
 281         buf->st_atime = attrs.atime;
 282         buf->st_mtime = attrs.mtime;
 283         buf->st_ctime = attrs.mtime;
 284     }
 285
 286     if ((attrs.flags & LIBSSH2_SFTP_ATTR_SIZE) != 0)
 287         buf->st_size = attrs.filesize;
 288
 289     if ((attrs.flags & LIBSSH2_SFTP_ATTR_PERMISSIONS) != 0)
 290         buf->st_mode = attrs.permissions;
 291
 292     return 0;
 293 }
 294
 295 /* --------------------------------------------------------------------------------------------- */
 296 /**
 297  * Read value of a symbolic link.
 298  *
 299  * @param vpath path to file or directory
 300  * @param buf   buffer for store stat-info
 301  * @param size  buffer size
 302  * @param error pointer to error object
 303  * @return 0 if sucess, negative value otherwise
 304  */
 305
 306 int
 307 sftpfs_readlink (const vfs_path_t * vpath, char *buf, size_t size, GError ** error)
 308 {
 309     struct vfs_s_super *super;
 310     sftpfs_super_data_t *super_data;
 311     int res;
 312     const vfs_path_element_t *path_element;
 313
 314     path_element = vfs_path_get_by_index (vpath, -1);
 315
 316     if (vfs_s_get_path (vpath, &super, 0) == NULL)
 317         return -1;
 318
 319     if (super == NULL)
 320         return -1;
 321
 322     super_data = (sftpfs_super_data_t *) super->data;
 323     if (super_data->sftp_session == NULL)
 324         return -1;
 325
 326     do
 327     {
 328         const char *fixfname;
 329
 330         fixfname = sftpfs_fix_filename (path_element->path);
 331
 332         res = libssh2_sftp_readlink (super_data->sftp_session, fixfname, buf, size);
 333         if (res >= 0)
 334             break;
 335
 336         if (res != LIBSSH2_ERROR_EAGAIN)
 337         {
 338             sftpfs_ssherror_to_gliberror (super_data, res, error);
 339             return -1;
 340         }
 341
 342         sftpfs_waitsocket (super_data, error);
 343         if (error != NULL && *error != NULL)
 344             return -1;
 345     }
 346     while (res == LIBSSH2_ERROR_EAGAIN);
 347
 348     return res;
 349 }
 350
 351 /* --------------------------------------------------------------------------------------------- */
 352 /**
 353  * Create symlink to file or directory
 354  *
 355  * @param vpath1 path to file or directory
 356  * @param vpath2 path to symlink
 357  * @param error  pointer to error object
 358  * @return 0 if sucess, negative value otherwise
 359  */
 360
 361 int
 362 sftpfs_symlink (const vfs_path_t * vpath1, const vfs_path_t * vpath2, GError ** error)
 363 {
 364     struct vfs_s_super *super;
 365     sftpfs_super_data_t *super_data;
 366     const vfs_path_element_t *path_element1;
 367     const vfs_path_element_t *path_element2;
 368     char *tmp_path;
 369     int res;
 370
 371     path_element2 = vfs_path_get_by_index (vpath2, -1);
 372
 373     if (vfs_s_get_path (vpath2, &super, 0) == NULL)
 374         return -1;
 375
 376     if (super == NULL)
 377         return -1;
 378
 379     super_data = (sftpfs_super_data_t *) super->data;
 380     if (super_data->sftp_session == NULL)
 381         return -1;
 382
 383     tmp_path = g_strdup_printf ("%c%s", PATH_SEP, path_element2->path);
 384     path_element1 = vfs_path_get_by_index (vpath1, -1);
 385
 386     do
 387     {
 388         const char *fixfname;
 389
 390         fixfname = sftpfs_fix_filename (path_element1->path);
 391
 392         res =
 393             libssh2_sftp_symlink_ex (super_data->sftp_session,
 394                                      fixfname,
 395                                      sftpfs_filename_buffer->len, tmp_path, strlen (tmp_path),
 396                                      LIBSSH2_SFTP_SYMLINK);
 397         if (res >= 0)
 398             break;
 399
 400         if (res != LIBSSH2_ERROR_EAGAIN)
 401         {
 402             sftpfs_ssherror_to_gliberror (super_data, res, error);
 403             g_free (tmp_path);
 404             return -1;
 405         }
 406
 407         sftpfs_waitsocket (super_data, error);
 408         if (error != NULL && *error != NULL)
 409         {
 410             g_free (tmp_path);
 411             return -1;
 412         }
 413     }
 414     while (res == LIBSSH2_ERROR_EAGAIN);
 415     g_free (tmp_path);
 416
 417     return 0;
 418 }
 419
 420 /* --------------------------------------------------------------------------------------------- */
 421 /**
 422  * Changes the permissions of the file.
 423  *
 424  * @param vpath path to file or directory
 425  * @param mode  mode (see man 2 open)
 426  * @param error pointer to error object
 427  * @return 0 if sucess, negative value otherwise
 428  */
 429
 430 int
 431 sftpfs_chmod (const vfs_path_t * vpath, mode_t mode, GError ** error)
 432 {
 433     struct vfs_s_super *super;
 434     sftpfs_super_data_t *super_data;
 435     LIBSSH2_SFTP_ATTRIBUTES attrs;
 436     int res;
 437     const vfs_path_element_t *path_element;
 438
 439     path_element = vfs_path_get_by_index (vpath, -1);
 440
 441     if (vfs_s_get_path (vpath, &super, 0) == NULL)
 442         return -1;
 443
 444     if (super == NULL)
 445         return -1;
 446
 447     super_data = (sftpfs_super_data_t *) super->data;
 448     if (super_data->sftp_session == NULL)
 449         return -1;
 450
 451     do
 452     {
 453         const char *fixfname;
 454
 455         fixfname = sftpfs_fix_filename (path_element->path);
 456
 457         res = libssh2_sftp_stat_ex (super_data->sftp_session, fixfname,
 458                                     sftpfs_filename_buffer->len, LIBSSH2_SFTP_LSTAT, &attrs);
 459         if (res >= 0)
 460             break;
 461
 462         if (res != LIBSSH2_ERROR_EAGAIN)
 463         {
 464             sftpfs_ssherror_to_gliberror (super_data, res, error);
 465             return -1;
 466         }
 467
 468         sftpfs_waitsocket (super_data, error);
 469         if (error != NULL && *error != NULL)
 470             return -1;
 471     }
 472     while (res == LIBSSH2_ERROR_EAGAIN);
 473
 474     attrs.permissions = mode;
 475
 476     do
 477     {
 478         const char *fixfname;
 479
 480         fixfname = sftpfs_fix_filename (path_element->path);
 481
 482         res = libssh2_sftp_stat_ex (super_data->sftp_session, fixfname,
 483                                     sftpfs_filename_buffer->len, LIBSSH2_SFTP_SETSTAT, &attrs);
 484         if (res >= 0)
 485             break;
 486         else if (res != LIBSSH2_ERROR_EAGAIN)
 487         {
 488             sftpfs_ssherror_to_gliberror (super_data, res, error);
 489             return -1;
 490         }
 491
 492         sftpfs_waitsocket (super_data, error);
 493         if (error != NULL && *error != NULL)
 494             return -1;
 495     }
 496     while (res == LIBSSH2_ERROR_EAGAIN);
 497     return res;
 498 }
 499
 500 /* --------------------------------------------------------------------------------------------- */
 501 /**
 502  * Delete a name from the file system.
 503  *
 504  * @param vpath path to file or directory
 505  * @param error pointer to error object
 506  * @return 0 if sucess, negative value otherwise
 507  */
 508
 509 int
 510 sftpfs_unlink (const vfs_path_t * vpath, GError ** error)
 511 {
 512     struct vfs_s_super *super;
 513     sftpfs_super_data_t *super_data;
 514     int res;
 515     const vfs_path_element_t *path_element;
 516
 517     path_element = vfs_path_get_by_index (vpath, -1);
 518
 519     if (vfs_s_get_path (vpath, &super, 0) == NULL)
 520         return -1;
 521
 522     if (super == NULL)
 523         return -1;
 524
 525     super_data = (sftpfs_super_data_t *) super->data;
 526     if (super_data->sftp_session == NULL)
 527         return -1;
 528
 529     do
 530     {
 531         const char *fixfname;
 532
 533         fixfname = sftpfs_fix_filename (path_element->path);
 534
 535         res =
 536             libssh2_sftp_unlink_ex (super_data->sftp_session, fixfname,
 537                                     sftpfs_filename_buffer->len);
 538         if (res >= 0)
 539             break;
 540
 541         if (res != LIBSSH2_ERROR_EAGAIN)
 542         {
 543             sftpfs_ssherror_to_gliberror (super_data, res, error);
 544             return -1;
 545         }
 546
 547         sftpfs_waitsocket (super_data, error);
 548         if (error != NULL && *error != NULL)
 549             return -1;
 550     }
 551     while (res == LIBSSH2_ERROR_EAGAIN);
 552
 553     return res;
 554 }
 555
 556 /* --------------------------------------------------------------------------------------------- */
 557 /**
 558  * Rename a file, moving it between directories if required.
 559  *
 560  * @param vpath1 path to source file or directory
 561  * @param vpath2 path to destination file or directory
 562  * @param error  pointer to error object
 563  * @return 0 if sucess, negative value otherwise
 564  */
 565
 566 int
 567 sftpfs_rename (const vfs_path_t * vpath1, const vfs_path_t * vpath2, GError ** error)
 568 {
 569     struct vfs_s_super *super;
 570     sftpfs_super_data_t *super_data;
 571     const vfs_path_element_t *path_element1;
 572     const vfs_path_element_t *path_element2;
 573     char *tmp_path;
 574     int res;
 575
 576     path_element2 = vfs_path_get_by_index (vpath2, -1);
 577
 578     if (vfs_s_get_path (vpath2, &super, 0) == NULL)
 579         return -1;
 580
 581     if (super == NULL)
 582         return -1;
 583
 584     super_data = (sftpfs_super_data_t *) super->data;
 585     if (super_data->sftp_session == NULL)
 586         return -1;
 587
 588     tmp_path = g_strdup_printf ("%c%s", PATH_SEP, path_element2->path);
 589     path_element1 = vfs_path_get_by_index (vpath1, -1);
 590
 591     do
 592     {
 593         const char *fixfname;
 594
 595         fixfname = sftpfs_fix_filename (path_element1->path);
 596
 597         res = libssh2_sftp_rename_ex
 598             (super_data->sftp_session,
 599              fixfname,
 600              sftpfs_filename_buffer->len, tmp_path, strlen (tmp_path), LIBSSH2_SFTP_SYMLINK);
 601         if (res >= 0)
 602             break;
 603
 604         if (res != LIBSSH2_ERROR_EAGAIN)
 605         {
 606             sftpfs_ssherror_to_gliberror (super_data, res, error);
 607             g_free (tmp_path);
 608             return -1;
 609         }
 610
 611         sftpfs_waitsocket (super_data, error);
 612         if (error != NULL && *error != NULL)
 613         {
 614             g_free (tmp_path);
 615             return -1;
 616         }
 617     }
 618     while (res == LIBSSH2_ERROR_EAGAIN);
 619     g_free (tmp_path);
 620
 621     return 0;
 622 }
 623
 624 /* --------------------------------------------------------------------------------------------- */