tools.h

Go to the documentation of this file.

/*MT*
    
    MediaTomb - http://www.mediatomb.cc/
    
    tools.h - this file is part of MediaTomb.
    
    Copyright (C) 2005 Gena Batyan <bgeradz@mediatomb.cc>,
                       Sergey 'Jin' Bostandzhyan <jin@mediatomb.cc>
    
    Copyright (C) 2006-2010 Gena Batyan <bgeradz@mediatomb.cc>,
                            Sergey 'Jin' Bostandzhyan <jin@mediatomb.cc>,
                            Leonhard Wimmer <leo@mediatomb.cc>
    
    MediaTomb is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 2
    as published by the Free Software Foundation.
    
    MediaTomb 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 General Public License for more details.
    
    You should have received a copy of the GNU General Public License
    version 2 along with MediaTomb; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
    
    $Id: tools.h 2081 2010-03-23 20:18:00Z lww $
*/

#ifndef __TOOLS_H__
#define __TOOLS_H__

#include "common.h"
#include "rexp.h"
#include "io_handler.h"
#include "cds_objects.h"
#include <sys/time.h>

#ifdef HAVE_MAGIC
// for older versions of filemagic
extern "C" {
#include <magic.h>
}

#endif

zmm::Ref<zmm::Array<zmm::StringBase> > split_string(zmm::String str, char sep, 
                                                    bool empty = false);

zmm::Ref<zmm::Array<zmm::StringBase> > split_path(zmm::String str);

zmm::String trim_string(zmm::String str);

bool check_path(zmm::String path, bool needDir = false);

time_t check_path_ex(zmm::String path, bool needDir = false, bool existenceUnneeded = false, off_t *filesize = NULL);

bool is_executable(zmm::String path, int *err = NULL);

zmm::String find_in_path(zmm::String exec);

bool string_ok(zmm::String str);

bool string_ok(zmm::Ref<zmm::StringBuffer> str);

void string_ok_ex(zmm::String str);

zmm::String http_redirect_to(zmm::String ip, zmm::String port, zmm::String page = _(""));

zmm::String hex_encode(void *data, int len);

zmm::String hex_decode_string(zmm::String encoded);


zmm::String generate_random_id();

zmm::String hex_md5(void *data, int length);

zmm::String hex_string_md5(zmm::String str);

zmm::String url_escape(zmm::String str);
 
zmm::String url_unescape(zmm::String str);

zmm::String mime_types_to_CSV(zmm::Ref<zmm::Array<zmm::StringBase> > mimeTypes);

zmm::String mt_strerror(int mt_errno);

zmm::String read_text_file(zmm::String path);

void write_text_file(zmm::String path, zmm::String contents);

void copy_file(zmm::String from, zmm::String to);

typedef int (*COMPARATOR) (void *, void *);
typedef void * COMPARABLE;

int StringBaseComparatorAsc(void *, void *);

void quicksort(COMPARABLE *arr, int size, COMPARATOR comparator);

zmm::String renderProtocolInfo(zmm::String mimetype, zmm::String protocol = _(PROTOCOL), zmm::String extend = nil);

zmm::String getMTFromProtocolInfo(zmm::String protocol);

zmm::String getProtocol(zmm::String protocolInfo);


zmm::String secondsToHMS(int seconds);

int HMSToSeconds(zmm::String time);

#ifdef HAVE_MAGIC
zmm::String get_mime_type(magic_set *ms, zmm::Ref<RExp> reMimetype, zmm::String file);
zmm::String get_mime_type_from_buffer(magic_set *ms, zmm::Ref<RExp> reMimetype,
                                         void *buffer, size_t length);

#endif // HAVE_MAGIC

#ifdef SOPCAST
int find_local_port(unsigned short range_min, 
                              unsigned short range_max);
#endif
zmm::String get_jpeg_resolution(zmm::Ref<IOHandler> ioh);

void set_jpeg_resolution_resource(zmm::Ref<CdsItem> item, int res_num);

bool check_resolution(zmm::String resolution, int *x = NULL, int *y = NULL);

zmm::String escape(zmm::String string, char escape_char, char to_escape);

zmm::String unescape(zmm::String string, char escape);

/*
zmm::String xml_unescape(zmm::String string);
*/

zmm::String unescape_amp(zmm::String string);

zmm::String fallbackString(zmm::String first, zmm::String fallback);

unsigned int stringHash(zmm::String str);

zmm::String intArrayToCSV(int *array, int size);

//inline void getTimeval(struct timeval *now) { gettimeofday(now, NULL); }

void getTimespecNow(struct timespec *ts);

long getDeltaMillis(struct timespec *first);
long getDeltaMillis(struct timespec *first, struct timespec *second);

void getTimespecAfterMillis(long delta, struct timespec *ret, struct timespec *start = NULL);
int compareTimespecs(struct timespec *a,  struct timespec *b);
/*
long getMillis(long startMillis = 0);

void millisToTimespec(long millis, struct timespec *spec);
*/

zmm::String normalizePath(zmm::String path);

zmm::String interfaceToIP(zmm::String interface);

bool validateYesNo(zmm::String value);


zmm::Ref<zmm::Array<zmm::StringBase> > parseCommandLine(zmm::String line, zmm::String in, zmm::String out);

zmm::String tempName(zmm::String leadPath, char *tmpl);

bool isTheora(zmm::String ogg_filename);

zmm::String get_last_path(zmm::String location);

ssize_t getValidUTF8CutPosition(zmm::String str, size_t cutpos);

#ifdef EXTEND_PROTOCOLINFO
zmm::String getDLNAtransferHeader(zmm::String mimeType, zmm::String header);
#endif

#ifndef HAVE_FFMPEG
zmm::String getAVIFourCC(zmm::String avi_filename);
#endif

#ifdef TOMBDEBUG

struct profiling_t
{
    struct timespec sum;
    struct timespec last_start;
    bool running;
    pthread_t thread;
};

#define PROFILING_T_INIT {{0,0},{0,0},false, pthread_self()}

void profiling_start(struct profiling_t *data);
void profiling_end(struct profiling_t *data);
void profiling_print(struct profiling_t *data);

#define PROF_INIT(var) profiling_t var = PROFILING_T_INIT
#define PROF_START(var) profiling_start(var)
#define PROF_END(var) profiling_end(var)
#define PROF_PRINT(var) profiling_print(var)

#else

#define profiling_t int
#define PROF_INIT(var) profiling_t var
#define PROF_START(var)
#define PROF_END(var)
#define PROF_PRINT(var)

/*
#define profiling_start()
#define profiling_end()
#define profiling_get_time()
*/

#endif

#endif // __TOOLS_H__

---