Ticket #6071: utils.py

#-*-coding: utf-8 -*-
"""
/dms/utils.py

.. enthaelt Hilfefunktionen fuer 
         Django content Management System

Hans Rauch

hans.rauch@gmx.net

Die Programme des dms-Systems koennen frei genutzt und den spezifischen
Beduerfnissen entsprechend angepasst werden.

0.01  13.01.2007  Beginn der Dokumentation
0.02  16.01.2007  check_name
0.03  20.1.2007   base_site_url
0.04  04.02.2007  bei Vortraegen wird der Titel in der breadcrum angezeigt
0.05  01.03.2007  send_control_email
0.06  17.05.2007  show_link - info=''
0.07  01.06.2007  get_folderish_actions ueberarbeitet
0.08  10.09.2007  add_if_app_available
0.09  02.10.2007  manage_site_mode, manage_domain_mode
0.10  03.10.2007  get_site_actions
0.11  17.10.2007  get_link_by_item_container fuer Redirects in Lernarchiven angepasst
0.12  23.10.2007  get_item_container_data_object_by_id
0.13  31.10.2007  PROJECT_FOLDER
0.14  10.11.2007  is_protected
"""

import string
import datetime

from django.utils.translation import ugettext as _

from math               import floor
from datetime           import date

from django.utils.translation import ugettext as _

from django.utils.encoding  import smart_unicode
from django             import newforms as forms

from django.utils.translation import ugettext as _

from dms.settings       import DOWNLOAD_URL
from dms.settings       import MY_DOMAINS

from dms.queries        import get_top_item
from dms.queries        import get_parent_item_container
from dms.queries        import get_menuitems_navmenu_top
from dms.queries        import get_menuitems_navmenu_left
from dms.queries        import is_file_by_item_container
from dms.queries        import get_prev_parent_item_containers
from dms.queries        import get_next_parent_item_containers
from dms.queries        import get_licenses
from dms.queries        import get_site_url
from dms.queries        import get_base_site_url
from dms.queries        import get_faecher
from dms.queries        import get_schularten
from dms.queries        import is_app_available
from dms.queries        import get_item_container_data_object_by_id
from dms.queries        import is_protected

from dms.encode_decode  import decode_html
from dms.encode_decode  import encode_html

from dms.text_icons     import FOLDER_ICON, PROJECT_ICON
from dms.text_icons     import EXTERN_ICON, NEW_WINDOW_ICON, FILE_DETAIL, REDIRECT_ICON

# -----------------------------------------------------
# E-Mail-Adressen verschluesseln

# Created by jmeile
# Anpassung an zecom: Hans Rauch, 3.12.2002, 04.01-2006

def encode_email(emailvalue, namevalue=None,rClass=None,info=None):
  #Taken from http://www.happysnax.com.au/testemail.php
  #Original comments:
  '''this function creates the hexadecimal equivalent to 
     "document.write('<a href="mailto:emailaddress">name</a>')"
     ie it effectively encrpts this as far as spam-bots are concerned
     the Javascript to unencrypt it simply changes the hex back into ascii
     then executes the code using the 'eval' statement
     /... and ta da ... you've got a normal mailto address displayed in the browser.
     //Written by Jeff Robson of Cynergic Net Solutions www.cynergic.net jeff.robson@cynergic.net'''
  if emailvalue == '' :
    return namevalue
  if namevalue == None :
    namevalue = emailvalue
  if rClass != None :
    cClass = ' class="' + rClass + '"'
  else :
    cClass = ''
  if info != None :
    cInfo = ' title="' + info + '"'
  else :
    cInfo = ''
  new_text = hex_string ( 'document.write(\'<a' + cClass + ' href=\"mailto:'+emailvalue+'\"' + \
                          cInfo + '>'+namevalue+'</a>\')' )
  return '<script type=\"text/javascript\">eval(unescape(\''+new_text+'\'))</script>'

def hex_string(mystring):
  #Taken from http://www.happysnax.com.au/testemail.php
  '''Written by Jeff Robson of Cynergic Net Solutions www.cynergic.net jeff.robson@cynergic.net'''
  newstring=''
  length=len(mystring)
  for i in range(length):
    newstring=newstring+'%'+tohex(ord(mystring[i]))
  return newstring

def tohex(n):
  #Taken from http://www.happysnax.com.au/testemail.php
  '''Written by Jeff Robson of Cynergic Net Solutions www.cynergic.net jeff.robson@cynergic.net'''
  hs='0123456789ABCDEF'
  return hs[int(floor(n/16))]+hs[n%16]

# -----------------------------------------------------
def get_footer_email(object, use_string_1=False):
  """ liefert Namen und Adresse des Autors """
  if smart_unicode(str(type(object))) == "<class 'dms.models.DmsItem'>":
    item = object
  else:
    item = object.item
  try:
    my_ext_item = get_ext_item(item)
    return encode_email(my_ext_item.owner_email, my_ext_item.owner, 'navLink')
  except:
    if use_string_1:
      return encode_email(item.string_2, item.string_1, 'navLink')
    else:
      return encode_email(item.owner.email, item.owner.get_full_name(), 'navLink')

def get_author_email(author, email):
  """ liefert Namen und Adresse des Autors """
  return encode_email(email, author, 'nav')

# -----------------------------------------------------
def get_tabbed_form(rFormItems, rFormHelp, rHelpName, rFormData,
                    do_tab=True, tab_cluster={}, valign=True, max_cols=1,
                    show_errors=True):
  """ baut Tabbed-Formulare zusammen: Quelle ??? """
  from dms.form_system        import form_system
  from django.template.loader import get_template
  from django.template        import Context

  t = get_template('utils/yui_tab_base.html')
  content = ''
  headers = []
  tabs = []
  tab_id = 'tab_'
  tab_no = 0
  for item in rFormItems:
    this_tab_id = tab_id + str(tab_no)
    tab_no += 1
    headers.append ( {'tab_id': this_tab_id, 
                      'text': rFormHelp[item[0]]['title'],
                      'selected': tab_no == 1
                      } )
    tabs.append ( {'tab_id': this_tab_id,
                    'info': rFormHelp[item[0]]['info'],
                    'content': form_system().get_form(item[1], rFormHelp,
                                    rHelpName, rFormData,
                                    tab_cluster, valign, max_cols, show_errors)
                  } )
    c = Context ( {'headers': headers, 'tabs': tabs } )
  return t.render(c)

# -----------------------------------------------------
def info_slot_to_header(text) :
  """ wandelt rechten Infoslot in HTML fuer WYSIWYG-Editor um """
  HEADER_START = '<!-- header start -->'
  HEADER_END   = '<!-- header end -->'
  INFO_START   = '<!-- info start -->'
  INFO_END     = '<!-- info end -->'
  ret = ''
  nStart = 0
  nHStart = string.find(text, HEADER_START, nStart)
  while nHStart >= 0 :
    nHEnd = string.find ( text, HEADER_END, nHStart )
    header  = text[nHStart+len(HEADER_START):nHEnd]
    nIStart = string.find ( text, INFO_START, nHEnd )
    nIEnd   = string.find ( text, INFO_END, nIStart )
    info    = text[nIStart+len(INFO_START):nIEnd]
    ret += '<h4>'+header+'</h4>\n'
    ret += info + '\n'
    nHStart = string.find(text, HEADER_START, nIEnd)
  return ret

# -----------------------------------------------------
def get_section_choices(sections):
  """ wandelt Textzeilen in Liste um """
  ret = []
  sections = string.splitfields(decode_html(sections), '\n')
  for s in sections :
    s = string.strip(s)
    ret.append((encode_html(s), s))
  return ret
  #  if s != '':
  #    yield(encode_html(s), s)

# -----------------------------------------------------
def get_parent_section_choices(my_item_container):
  item_container = get_parent_item_container(my_item_container)
  return get_section_choices(item_container.container.sections)

# -----------------------------------------------------
def get_license_choices(my_item_container):
  #return get_section_choices(get_licenses())
  ret = []
  licenses = get_licenses()
  for lic in licenses:
    if lic.url != '':
      l = show_link(lic.url, lic.name)
    else:
      l = lic.name
    ret.append((lic.id, l))
  return ret

# -----------------------------------------------------
def get_fach_choices():
  # --- Liste aller Faecher
  ret = []
  ret.append((-1, '---'))
  faecher = get_faecher()
  for fach in faecher:
    ret.append((fach.id, decode_html(fach.name)))
  return ret

# -----------------------------------------------------
def get_schulart_choices():
  # --- Liste aller Faecher
  ret = []
  ret.append((-1, '---'))
  schularten = get_schularten()
  for schulart in schularten:
    ret.append((schulart.id, decode_html(schulart.name)))
  return ret

# -----------------------------------------------------
def check_name( name, is_name_ok):
  """ entfernt Umlaute etc. aus Dateinamen """
  try:
    name = unicode(name, 'utf-8')
  except:
    pass
  name = name[max(string.rfind(name,'/'),
                  string.rfind(name,'\\'),
                  string.rfind(name,':')
                  )+1:]
  name = string.replace(name, u"'", u'_')
  name = string.replace(name, u'ä', u'ae')
  name = string.replace(name, u'ö', u'oe')
  name = string.replace(name, u'ü', u'ue')
  name = string.replace(name, u'Ä', u'Ae')
  name = string.replace(name, u'Ö', u'Oe')
  name = string.replace(name, u'Ü', u'Ue')
  name = string.replace(name, u'ß', u'ss')
  bad_chars  = ' ,;()[]{}*"#%+~!'
  good_chars = '________________'
  TRANSMAP = string.maketrans(bad_chars, good_chars)
  name = name.encode('iso-8859-1')
  name = string.translate(name, TRANSMAP)
  if is_name_ok:
    return name
  html = '.html'
  if name[-5:] != html :
    name += html
  return name

# -----------------------------------------------------
def show_link(url, info='', url_extern=False, url_class='', title=''):
  """ zeigt Verweise an - externe Verweise werden optisch gekennzeichnet """
  if info == '':
    if url.startswith('http://'):
      info += url[7:]
    else:
      info = url
  from dms.settings import MY_DOMAINS
  from django.template.loader import get_template
  from django.template import Context
  t = get_template('utils/show_link.html')
  target = ''
  start  = ''
  is_my_domain = False
  # --- Parameter in URL ausschliessen
  n_pos = url.find('?')
  if n_pos > -1:
    u = url[:n_pos]
  else:
    u = url
  if u.startswith('http://'):
    for domain in MY_DOMAINS:
      if u.find(domain) >= 0 :
        is_my_domain = True
        break
    if is_my_domain :
      if url_extern :
        target = '_extern'
        start  = NEW_WINDOW_ICON
    else :
      target = '_extern'
      start  = EXTERN_ICON
  else :
    # Javascript - das Oeffnen in einem eigenen Fenster erfolgt ueber Javascript
    #target = '_extern'
    start  = NEW_WINDOW_ICON
  if url_class != '' and not url_class.startswith('class='):
    url_class = u' class="%s"' % url_class
  if title != '' and not title.startswith('title='):
    title = u' title="%s"' % title
  c = Context ( {'start': start, 'url' : url, 'class': url_class, 
                 'target': target, 'info': info, 'title': title } )
  return t.render(c)

# -----------------------------------------------------
def get_link_by_item_container(item_container, is_folder=False):
  """ liefert die entsprechende URL """
  d_extern = ''
  d_info = ''
  d_title = item_container.item.title
  if item_container.item.app.is_folderish or is_folder:
    #d_class = 'class="folderLink" '
    postfix = FOLDER_ICON
  else :
    #d_class = ''
    postfix = ''
  # --- handelt es sich um ein Datei- oder Ordner-Objekt?
  is_file = is_file_by_item_container(item_container)
  is_text = item_container.item.app.name == 'dmsText'
  if string.find(item_container.item.name, '.html') > 0 or is_file or is_text:
    if item_container.item.app.name == 'dmsRedirect':
      d_url = item_container.item.url_more
      if string.find(item_container.item.url_more, 'http://') >= 0:
        is_my_domain = False
        for domain in MY_DOMAINS:
          if string.find(item_container.item.url_more, domain) >= 0:
            is_my_domain = True
            break
        if is_my_domain:
          if item_container.item.url_more_extern:
            d_extern = '_extern'
            d_extern_icon = NEW_WINDOW_ICON
        else :
          d_extern = '_extern'
          d_extern_icon = EXTERN_ICON
    elif is_file:
      d_extern = '_extern'
      d_extern_icon = NEW_WINDOW_ICON
      d_info = FILE_DETAIL % get_site_url(item_container, item_container.item.name + '/show/')
      d_url = DOWNLOAD_URL + item_container.container.path + item_container.item.name
    else:
      d_url = get_site_url(item_container, item_container.item.name)
  else :
    if item_container.is_data_object:
      d_url = get_site_url(item_container, 'index.html')
    else:
      real_item_container = get_item_container_data_object_by_id(item_container.item.id)
      if real_item_container == None:
        d_url = get_site_url(item_container, 'index.html')
      else:
        d_url = get_site_url(real_item_container[0], 'index.html')
  if d_extern:
    help = _('Wird in einem eigenen Fenster ge&ouml;ffnet ...')
    this_link = d_extern_icon + u'<a href="%s" target="d_extern" title="%s">%s</a>' % \
                        (d_url, help, d_title)
  elif item_container.item.app.name == 'dmsRedirect' or not item_container.is_data_object:
    s_info = REDIRECT_ICON + '&nbsp;'
    help = _('Springt zu einer anderen Stelle ...')
    this_link = s_info + u'<a href="%s" title="%s">%s</a>' % (d_url, help, d_title)
  else:
    this_link = u'<a href="%s">%s</a>' % (d_url, d_title)
  if is_protected(item_container):
    return '<i>' + this_link + d_info + '</i>' + PROJECT_ICON
  return this_link + d_info + postfix

# -----------------------------------------------------
def show_more ( url, url_extern, info='Mehr ...' ) :
  """ erzeugt einen Verweis fuer "mehr ..." """
  return show_link ( url, info, url_extern )

# -----------------------------------------------------
def get_breadcrumb(item_container, text_only=False, ignore_own_breadcrumb=False):
  """ Navigationszeile zusammenbauen """
  if text_only:
    ret = ''
    length = len(item_container.container.site.base_folder)
    n = 0  # --- Begrenzung der Schachtelungstiefe
    if not item_container.item.app.is_folderish:
      item_container = get_parent_item_container(item_container)
    while     item_container != None \
          and (ignore_own_breadcrumb or \
               not item_container.item.app.has_own_breadcrumb) \
          and not item_container.container.is_top_folder \
          and item_container.parent_item_id != -1 \
          and n < 20:
      ret = item_container.container.nav_title + ' | ' + ret
      n += 1
      if n >= 20:
        assert False
      item_container = get_parent_item_container(item_container)
    return ret
  else:
    from django.template.loader import get_template
    from django.template import Context
    t = get_template('utils/nav_item.html')
    ret = ''
    length = len(item_container.container.site.base_folder)
    n = 0  # --- Begrenzung der Schachtelungstiefe
    if not item_container.item.app.is_folderish:
      item_container = get_parent_item_container(item_container)
    while         item_container != None \
          and (ignore_own_breadcrumb or \
               not item_container.item.app.has_own_breadcrumb) \
          and not item_container.container.is_top_folder \
          and item_container.parent_item_id != -1 \
          and n < 20:
      c = Context( {'url'  : item_container.container.site.url+\
                             item_container.container.path[length:]+'index.html',
                    'title': item_container.item.title,
                    'info' : item_container.container.nav_title,})
      ret = t.render(c) + ret
      n += 1
      if n >= 20:
        assert False
      item_container = get_parent_item_container(item_container)
    if item_container != None:
      if item_container.item.app.has_own_breadcrumb :
        c=Context({'url'  : get_site_url(item_container, 'index.html'),
                  'title': item_container.item.title,
                  'info' : item_container.container.nav_title,})
        ret = t.render(c) + ret
        parent_item_container = get_parent_item_container(item_container)
        c=Context({'url'  : parent_item_container.get_absolute_url(),
                  'title': _('Zur&uuml;ck zu den normalen Web-Seiten'),
                  'info' : _('Ausgang'),})
      elif item_container.container.is_top_folder:
        c=Context({'url'  : get_site_url(item_container, 'index.html'),
                  'title': item_container.item.title,
                  'info' : item_container.container.nav_title,})
        ret = t.render(c) + ret
        item_container = get_top_item()
        c=Context({'url'  : get_site_url(item_container, 'index.html'),
                  'title': item_container.item.title,
                  'info' : item_container.container.nav_title,})
      else:
        c=Context({'url'  : get_site_url(item_container, 'index.html'),
                  'title': item_container.item.title,
                  'info' : item_container.container.nav_title,})
      ret = t.render(c) + ret
      return ret
    else:
      return 'item_container == None!!!'

# -----------------------------------------------------
def get_prev_next(item_container):
  """ Geschwisterseiten """

  def get_string(line, max_char=30):
    if len(line) < max_char:
      return line
    return line[:max_char] + ' ...'

  items = get_prev_parent_item_containers(item_container)
  p_len = len(items)
  if p_len == 0:
    prev_url  = ''
    prev_info = ''
  else:
    p_item = items[p_len-1].item
    prev_url  = p_item.name
    prev_info = get_string(p_item.title)
  items = get_next_parent_item_containers(item_container)
  if len(items) >0:
    next_url  = items[0].item.name
    next_info = get_string(items[0].item.title)
  else:
    next_url  = ''
    next_info = ''
  return prev_url, prev_info, next_url, next_info

# -----------------------------------------------------
def get_prev_next_line(item_container):
  """ Geschwisterseiten anzeigen """
  from django.template.loader import get_template
  from django.template import Context
  t = get_template('utils/prev_next.html')
  prev_url, prev_info, next_url, next_info = get_prev_next(item_container)
  c = Context({'prev_url'    : prev_url,
               'prev_info'   : prev_info,
               'complete_url': './index.html/show_complete/',
               'next_url'    : next_url,
               'next_info'   : next_info, })
  return t.render(c)

# -----------------------------------------------------
def get_folderish_actions(request, user_perms, item_container, app_name,
                          has_user_folder, dont={}):
  from django.template.loader import get_template
  from django.template import Context
  if not request.user.is_authenticated():
    return ''
  t = get_template('app/manage_options_folderish.html')
  nPos = max ( string.rfind ( request.path, '/add/' ),
               string.rfind ( request.path, '/edit/' ),
               string.rfind ( request.path, '/navigation/' ),
               string.rfind ( request.path, '/navigation_left/' ),
               string.rfind ( request.path, '/navigation_top/' ),
               string.rfind ( request.path, '/manage/' ),
               string.rfind ( request.path, '/manage_browseable/' ),
               string.rfind ( request.path, '/manage_comments/' ),
               string.rfind ( request.path, '/import/' ),
               string.rfind ( request.path, '/export/' ),
               string.rfind ( request.path, '/manage_site/' ),
               string.rfind ( request.path, '/manage_user/' ),
               string.rfind ( request.path, '/sort/' ),
               string.rfind ( request.path, '/empty_folders/' ),
               string.rfind ( request.path, '/find_items/' ),
             )
  if nPos >