share/common/quvi/const.lua

   1 -- libquvi-scripts
   2 -- Copyright (C) 2010-2012  Toni Gundogdu <legatvs@gmail.com>
   3 --
   4 -- This file is part of libquvi-scripts <http://quvi.sourceforge.net/>.
   5 --
   6 -- This program is free software: you can redistribute it and/or
   7 -- modify it under the terms of the GNU Affero General Public
   8 -- License as published by the Free Software Foundation, either
   9 -- version 3 of the License, or (at your option) any later version.
  10 --
  11 -- This program is distributed in the hope that it will be useful,
  12 -- but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 -- GNU Affero General Public License for more details.
  15 --
  16 -- You should have received a copy of the GNU Affero General
  17 -- Public License along with this program.  If not, see
  18 -- <http://www.gnu.org/licenses/>.
  19 --
  20
  21 local M = {}
  22
  23 -- (q)uvi.(f)etch (o)ption
  24 M.qfo_from_charset = 0x0 -- Convert (to UTF-8) from this charset
  25 M.qfo_user_agent   = 0x1 -- Set user-agent string value
  26 M.qfo_cookie       = 0x2 -- Set an arbitrary cookie
  27 M.qfo_type         = 0x3 -- Fetch type (see qft_*)
  28
  29 -- (q)uvi.(f)etch (t)ype
  30 M.qft_playlist = 0x0
  31 M.qft_config   = 0x1
  32 M.qft_url      = 0x2 -- default
  33
  34 --[[
  35 NOTES
  36 =====
  37
  38 qfo_from_charset
  39 ----------------
  40 Instructs the library to convert from this charset to UTF-8. Using this
  41 option may be required with the websites that use a specific (non-UTF8)
  42 encoding.
  43
  44 The purpose of this option is to make sure that the data is encoded to
  45 unicode (UTF-8) before any of it is parsed and returned to the
  46 application using libquvi.
  47
  48 By default, libquvi converts the data which is in the encoding used for
  49 the strings by the C runtime in the current locale into UTF-8.  IF this
  50 fails, and the 'from charset' option is set, the library will then try
  51 to convert to UTF-8 using the 'from charset' value.
  52
  53 qfo_cookie
  54 ----------
  55 When set, the arbitrary cookie will be used with the quvi.fetch .
  56 The cookies are handled by libcurl, look up the CURLOPT_COOKIE
  57 description for details. If you must define >1 cookies, use the
  58 following format: "foo=1; bar=2;" .
  59
  60 EXAMPLES
  61 ========
  62 local C = require 'quvi/const'
  63
  64 local p = quvi.fetch(URL, {[C.qfo_cookie] = 'foo=1'})
  65 local p = quvi.fetch(URL, {[C.qfo_type] = C.qft_config})
  66
  67 local t = {
  68   [C.qfo_cookie] = 'foo=1; bar=2;',
  69   [C.qfo_type] = C.qft_config
  70 }
  71 local p = quvi.fetch(URL, t)
  72 ]]--
  73
  74 return M
  75
  76 -- vim: set ts=2 sw=2 tw=72 expandtab: