vlc/modules/access/gopher.c

/*****************************************************************************
 * gopher.c: gopher input module
 *****************************************************************************
 * Copyright (C) 2003-2004 VLC authors and VideoLAN
 * Copyright (C) 2019-2020 Vincenzo "KatolaZ" Nicosia
 *
 * Authors: Vincenzo "KatolaZ" Nicosia <katolaz@freaknet.org>
 *
 * This module was adapted from tcp.c
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include <vlc_common.h>
#include <vlc_plugin.h>
#include <vlc_access.h>
#include <vlc_messages.h>
#include <vlc_url.h>
#include <vlc_tls.h>

#include <stdio.h>
#include <string.h>

/* Forward declarations */
static int Open(vlc_object_t *);
static void Close(vlc_object_t *);

/* Module descriptor */
vlc_module_begin ()
    set_description( N_("Gopher input") )
    set_capability( "access", 0 )
    set_shortname( "gopher" )
    set_subcategory( SUBCAT_INPUT_ACCESS )
    add_shortcut( "gopher")
    set_callbacks( Open, Close )
vlc_module_end ()


static ssize_t Read(stream_t *access, void *buf, size_t len)
{
    return vlc_tls_Read(access->p_sys, buf, len, false);
}

static int Control( stream_t *p_access, int i_query, va_list args )
{
    bool    *pb_bool;

    switch( i_query )
    {
        case STREAM_CAN_SEEK:
        case STREAM_CAN_FASTSEEK:
            pb_bool = va_arg( args, bool * );
            *pb_bool = false;
            break;
        case STREAM_CAN_PAUSE:
            pb_bool = va_arg( args, bool * );
            *pb_bool = true;    /* FIXME */
            break;
        case STREAM_CAN_CONTROL_PACE:
            pb_bool = va_arg( args, bool * );
            *pb_bool = true;    /* FIXME */
            break;

        case STREAM_GET_PTS_DELAY:
            *va_arg( args, vlc_tick_t * ) =
                VLC_TICK_FROM_MS(var_InheritInteger( p_access, "network-caching" ));
            break;

        case STREAM_SET_PAUSE_STATE:
            /* Nothing to do */
            break;

        default:
            return VLC_EGENERIC;
    }
    return VLC_SUCCESS;
}



static int Open(vlc_object_t *obj)
{
    char *psz_path = NULL;
    stream_t *access = (stream_t *)obj;
    vlc_tls_t *sock;
    vlc_url_t url;


    if (vlc_UrlParse(&url, access->psz_url) || url.psz_host == NULL) 
    {
        msg_Err(access, "invalid location: %s", access->psz_location);
        vlc_UrlClean(&url);
        return VLC_EGENERIC;
    }

    if (url.i_port == 0)
    {
        url.i_port = 70;
    }
    sock = vlc_tls_SocketOpenTCP(obj, url.psz_host, url.i_port);

    if (unlikely(sock == NULL))
    {
        msg_Err(access, "cannot connect to %s:%d", url.psz_host, url.i_port);
        vlc_UrlClean(&url);
        return VLC_EGENERIC;
    }

    if (url.psz_path == NULL || strlen(url.psz_path) <= 3)
    {
        /* If no resource type is specified, look for the root resource */
        if (asprintf(&psz_path, "\r\n") == -1)
        {
            vlc_UrlClean(&url);
            vlc_tls_SessionDelete(sock);
            return VLC_EGENERIC;
        }
        msg_Info(access, "path set to root resource");
    }
    else { /* strip resource type from URL */
        if(asprintf(&psz_path, "%s\r\n", url.psz_path+2) == -1)
        {
            vlc_UrlClean(&url);
            vlc_tls_SessionDelete(sock);
            return VLC_EGENERIC;
        }
        msg_Info(access, "stripped resource type from path");
    }
    vlc_UrlClean(&url);

    access->p_sys = sock;
    access->pf_read = Read;
    access->pf_block = NULL;
    access->pf_control = Control;
    access->pf_seek = NULL;

    msg_Dbg(access, "requesting resource: %s", psz_path);
    if (vlc_tls_Write(access->p_sys, psz_path, strlen(psz_path)) < 0)
    {
        vlc_tls_SessionDelete(access->p_sys);
        free(psz_path);
        return VLC_EGENERIC;
    }

    free(psz_path);
    return VLC_SUCCESS;
}

static void Close( vlc_object_t *p_this )
{
    stream_t *access = (stream_t *)p_this;

    vlc_tls_SessionDelete(access->p_sys);
}