src/Hage1/misc.py

   1 # Copyright (C) 2006 by Aiwota Programmer
   2 # aiwotaprog@tetteke.tk
   3 #
   4 # This program is free software; you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation; either version 2 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program; if not, write to the Free Software
  16 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 import os.path
  19
  20 import config
  21 import brdlist
  22
  23 def get_logs_dir_path():
  24     return os.path.join(config.get_config_dir_path(), "logs")
  25
  26 def get_board_base_url(bbs, board):
  27     """
  28     None: this function uses brdlist.get function, so brdlist.read function
  29     should have been called before this function is called
  30     """
  31     # if parameter is empty, raise ValueError
  32     if not bbs or not board:
  33         raise ValueError, "parameter must not be empty"
  34
  35     return "http://" + brdlist.get(bbs, board, "host") + "/" + board + "/"
  36
  37 def get_board_subjecttxt_url(bbs, board):
  38     """Returns subject.txt file url
  39
  40     bbs: bbs id
  41
  42     board: board id
  43     """
  44
  45     # if parameter is empty, raise ValueError
  46     if not bbs or not board:
  47         raise ValueError, "parameter must not be empty"
  48
  49     return get_board_base_url(bbs, board) + "subject.txt"
  50
  51 def get_board_subjecttxt_path(bbs, board):
  52     """Returns subject.txt file path
  53
  54     bbs: bbs id
  55
  56     board: board id
  57     """
  58
  59     # if parameter is empty, raise ValueError
  60     if not bbs or not board:
  61         raise ValueError, "parameter must not be empty"
  62
  63     return os.path.join(get_logs_dir_path(), bbs, board, "subject.txt")
  64
  65 def get_board_dir_path(bbs, board):
  66     """Returns board dir path
  67
  68     bbs: bbs ID
  69
  70     board: board ID
  71     """
  72
  73     # if parameter is empty, raise ValueError
  74     if not bbs or not board:
  75         raise ValueError, "parameter must not be empty"
  76
  77     return os.path.join(get_logs_dir_path(), bbs, board)
  78
  79 def get_thread_idx_path(bbs, board, thread):
  80     """Returns idx file path of thread
  81
  82     bbs: bbs ID
  83
  84     board: board ID
  85
  86     thread: thread ID
  87
  88     Note: if parameter is empty, raise ValueError
  89     """
  90
  91     # if parameter is empty, raise ValueError
  92     if not bbs or not board or not thread:
  93         raise ValueError, "parameter must not be empty"
  94
  95     return os.path.join(get_logs_dir_path(), bbs, board, thread + ".idx")
  96
  97 def get_board_cache_path(bbs, board):
  98     """ Returns .cache file path of board
  99
 100     bbs: bbs ID
 101
 102     board: board ID
 103
 104     Note: if parameter is empty, raise ValueError
 105     """
 106
 107     # if parameter is empty, raise ValueError
 108     if not bbs or not board:
 109         raise ValueError, "parameter must not be empty"
 110
 111     return os.path.join(get_logs_dir_path(), bbs, board, ".cache")