project.py

# -*- coding: utf-8 -*-

"""
    Project Tracking & Management
"""

module = request.controller
resourcename = request.function

if not settings.has_module(module):
    raise HTTP(404, body="Module disabled: %s" % module)

mode_task = settings.get_project_mode_task()

# =============================================================================
def index():
    """ Module's Home Page """

    if mode_task:
        # Bypass home page & go direct to browsing Tasks for a Project
        redirect(URL(f="project", vars={"tasks":1}))
    else:
        # Bypass home page & go direct to filterable list of Projects
        redirect(URL(f="project"))

# =============================================================================
def create():
    """ Redirect to project/create """
    redirect(URL(f="project", args="create"))

# -----------------------------------------------------------------------------
def project():
    """ RESTful CRUD controller """

    if "tasks" in get_vars:
        # Open-Tasks-For-Project Selector
        return open_tasks_for_project()
        
    # Pre-process
    def prep(r):
        
        # Location Filter
        s3db.gis_location_filter(r)

        component = r.component
        component_name = component.name if component else None

        hr_group = r.get_vars.get("group")

        if r.method == "datalist":
            # Set list_fields for renderer (project_project_list_layout)
            s3db.configure("project_project",
                           list_fields = ["name",
                                          "description",
                                          "location.location_id",
                                          "start_date",
                                          "organisation_id",
                                          "organisation_id$logo",
                                          "modified_by",
                                          ]
                           )

        # Filter human resource records if "group" in get_vars
        elif component_name == "human_resource":
            type_field = FS("human_resource.type")
            if hr_group == "staff":
                query = (type_field == 1)
            elif hr_group == "volunteer":
                query = (type_field == 2)
            else:
                query = None
            if query:
                r.resource.add_component_filter("human_resource", query)

        if r.interactive:
            htable = s3db.hrm_human_resource
            htable.person_id.comment = DIV(_class="tooltip",
                                           _title="%s|%s" % (T("Person"),
                                                             T("Select the person assigned to this role for this project."),
                                                            )
                                          )

            if not component or component_name == "activity":
                # Filter Themes/Activity Types based on Sector
                if r.record:
                    table = s3db.project_sector_project
                    query = (table.project_id == r.id) & \
                            (table.deleted == False)
                    rows = db(query).select(table.sector_id)
                    sector_ids = [row.sector_id for row in rows]
                else:
                    sector_ids = []
                set_theme_requires(sector_ids)

            if not r.component:
                if r.method in ("create", "update"):
                    # Context from a Profile page?"
                    location_id = get_vars.get("(location)", None)
                    if location_id:
                        field = s3db.project_location.location_id
                        field.default = location_id
                        field.readable = field.writable = False
                    organisation_id = get_vars.get("(organisation)", None)
                    if organisation_id:
                        field = r.table.organisation_id
                        field.default = organisation_id
                        field.readable = field.writable = False

                if r.id:
                    r.table.human_resource_id.represent = \
                        s3db.hrm_HumanResourceRepresent(show_link=True)
                    
                elif r.get_vars.get("project.status_id", None):
                    stable = s3db.project_status
                    status = get_vars.get("project.status_id")
                    row = db(stable.name == status).select(stable.id,
                                                           limitby=(0, 1)).first()
                    if row:
                        r.table.status_id.default = row.id
                        r.table.status_id.writable = False
                        
            elif component_name == "organisation":
                if r.method != "update":
                    allowed_roles = dict(settings.get_project_organisation_roles())
                    if settings.get_template() == "DRRPP":
                        # Partner NS should only come via sync from RMS
                        allowed_roles.pop(9, None)

                    lead_role = 1
                    otable = s3db.project_organisation
                    query = (otable.project_id == r.id) & \
                            (otable.role == lead_role) & \
                            (otable.deleted != True)
                    row = db(query).select(otable.id,
                                           limitby=(0, 1)).first()
                    if row:
                        # Project has already a lead organisation
                        # => exclude lead_role in component add-form
                        allowed_roles.pop(lead_role, None)
                    otable.role.requires = IS_EMPTY_OR(IS_IN_SET(allowed_roles))

            elif component_name == "activity":
                # Filter Activity Type based on Sector
                set_activity_type_requires("project_activity_activity_type", sector_ids)

            elif component_name == "task":
                if not auth.s3_has_role("STAFF"):
                    # Hide fields which are meant for staff members
                    # (avoid confusion both of inputters & recipients)
                    unwanted_fields = ["source",
                                       "pe_id",
                                       "date_due",
                                       "time_estimated",
                                       "time_actual",
                                       "status",
                                       ]
                    ttable = component.table
                    for fieldname in unwanted_fields:
                        field = ttable[fieldname]
                        field.readable = field.writable = False

                if "open" in r.get_vars:
                    # Show only the Open Tasks for this Project (unused?)
                    statuses = s3.project_task_active_statuses
                    query = FS("status").belongs(statuses)
                    r.resource.add_component_filter("task", query)

            elif component_name == "beneficiary":
                # Filter the location selector to the project's locations
                component.table.project_location_id.requires = \
                    IS_EMPTY_OR(IS_ONE_OF(db, "project_location.id",
                                          s3db.project_location_represent,
                                          sort=True,
                                          filterby="project_id",
                                          filter_opts=[r.id],
                                          )
                                )

            elif component_name == "human_resource":

                htable = s3db.hrm_human_resource
                htable.person_id.represent = \
                    s3db.pr_PersonRepresent(show_link=True)

                # These values are defined in hrm_type_opts
                human_resource_id = component.table.human_resource_id
                filter_opts = None
                if hr_group:
                    crud_strings = s3.crud_strings
                    if hr_group == "staff":
                        filter_opts = (1,)
                        human_resource_id.label = T("Staff")
                        crud_strings["project_human_resource"] = crud_strings["hrm_staff"]

                    elif hr_group == "volunteer":
                        filter_opts = (2,)
                        human_resource_id.label = T("Volunteer")
                        crud_strings["project_human_resource"] = crud_strings["hrm_volunteer"]

                if filter_opts:
                    # Use the group to filter the form widget when
                    # adding a new record
                    human_resource_id.requires = \
                        IS_ONE_OF(db, "hrm_human_resource.id",
                                  s3db.hrm_human_resource_represent,
                                  filterby="type",
                                  filter_opts=filter_opts,
                                  orderby="hrm_human_resource.person_id",
                                  sort=True
                        )

            elif component_name == "document":
                # Hide unnecessary fields
                dtable = component.table
                dtable.organisation_id.readable = \
                dtable.organisation_id.writable = False
                dtable.person_id.readable = \
                dtable.person_id.writable = False
                dtable.location_id.readable = \
                dtable.location_id.writable = False

        return True
    s3.prep = prep

    # Post-process
    def postp(r, output):
        
        if r.interactive:
            
            if not r.component:
                # Set the minimum end_date to the same as the start_date
                s3.jquery_ready.append(
'''S3.start_end_date('project_project_start_date','project_project_end_date')''')
                if mode_task:
                    read_url = URL(args=["[id]", "task"])
                    update_url = URL(args=["[id]", "task"])
                    s3_action_buttons(r,
                                      read_url=read_url,
                                      update_url=update_url)
                                              
            elif r.component_name == "beneficiary":
                # Set the minimum end_date to the same as the start_date
                s3.jquery_ready.append(
'''S3.start_end_date('project_beneficiary_date','project_beneficiary_end_date')''')
                
        return output
    s3.postp = postp

    return s3_rest_controller(module, "project",
                              csv_template = "project",
                              hide_filter = {None: False, "_default": True},
                              rheader = s3db.project_rheader,
                              )

# -----------------------------------------------------------------------------
def open_tasks_for_project():
    """
        Simplified controller to select a project and open the
        list of open tasks for it
    """
    
    def prep(r):
        tablename = "project_project"
        s3.crud_strings[tablename].title_list = T("Open Tasks for Project")
        s3.crud_labels.READ = s3.crud_labels.UPDATE = T("Select")
        s3db.configure(tablename,
                       deletable=False,
                       listadd=False,
                      )
        return True
    s3.prep = prep

    # Post-process
    def postp(r, output):
        if r.interactive and not r.component:
            tasklist_url = URL(f="task", vars={"project":"[id]"})
            s3_action_buttons(r,
                              deletable=False,
                              read_url=tasklist_url,
                              update_url=tasklist_url)
        return output
    s3.postp = postp
    
    return s3_rest_controller(module, "project",
                              hide_filter=False,
                             )
# -----------------------------------------------------------------------------
def set_theme_requires(sector_ids):
    """
        Filters the theme_id based on the sector_id
    """

    ttable = s3db.project_theme
    tstable = s3db.project_theme_sector

    # All themes linked to the project's sectors or to no sectors 
    rows = db().select(ttable.id,
                       tstable.sector_id,
                       left=tstable.on(ttable.id == tstable.theme_id))
    sector_ids = sector_ids or []
    theme_ids = [row.project_theme.id for row in rows 
                 if not row.project_theme_sector.sector_id or 
                    row.project_theme_sector.sector_id in sector_ids]
    table = s3db.project_theme_project
    table.theme_id.requires = IS_EMPTY_OR(
                                IS_ONE_OF(db, "project_theme.id",
                                          s3base.S3Represent(lookup="project_theme"),
                                          filterby="id",
                                          filter_opts=theme_ids,
                                          sort=True,
                                          )
                                )

# -----------------------------------------------------------------------------
def set_activity_type_requires(tablename, sector_ids):
    """
        Filters the activity_type_id based on the sector_id
    """

    attable = s3db.project_activity_type
    if sector_ids:
        atstable = s3db.project_activity_type_sector

        # All activity_types linked to the projects sectors or to no sectors 
        rows = db().select(attable.id,
                           atstable.sector_id,
                           left=atstable.on(attable.id == atstable.activity_type_id))
        activity_type_ids = [row.project_activity_type.id for row in rows 
                     if not row.project_activity_type_sector.sector_id or 
                        row.project_activity_type_sector.sector_id in sector_ids]
    else:
        activity_type_ids = []
    s3db[tablename].activity_type_id.requires = IS_EMPTY_OR(
                                    IS_ONE_OF(db, "project_activity_type.id",
                                              s3base.S3Represent(lookup="project_activity_type"),
                                              filterby="id",
                                              filter_opts=activity_type_ids,
                                              sort=True,
                                              )
                                    )

# -----------------------------------------------------------------------------
def project_theme_id_widget():
    """
        Used by the project controller to return dynamically generated 
        theme_id widget based on sector_id
        - deprecated?
    """

    table = s3db.project_theme_project
    sector_ids = [int(id) for id in request.vars.sector_ids.split(",") if id]
    if "value" in request.vars:
        value = [int(id) for id in request.vars.value.split(",") if id]
    else:
        value = []
    
    set_theme_requires(sector_ids)
    widget = table.theme_id.widget(table.theme_id,
                                   value)
    return widget

# =============================================================================
def sector():
    """ RESTful CRUD controller """

    return s3_rest_controller("org", "sector")

# -----------------------------------------------------------------------------
def status():
    """ RESTful CRUD controller """

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def theme():
    """ RESTful CRUD controller """

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def theme_project():
    """
        RESTful CRUD controller
        - not normally exposed to users via a menu
    """

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def theme_sector():
    """ RESTful CRUD controller for options.s3json lookups """

    if auth.permission.format != "s3json":
        return ""

    # Pre-process
    def prep(r):
        if r.method != "options":
            return False
        return True
    s3.prep = prep

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def theme_sector_widget():
    """ Render a Widget with Theme options filtered by Sector """

    try:
        values = get_vars.sector_ids.split(",")
        values = [int(v) for v in values]
    except:
        values = []

    widget = s3base.s3forms.S3SQLInlineComponentCheckbox(
        "theme",
        label = T("Themes"),
        field = "theme_id",
        cols = 4,
        translate = True,
        # Filter Theme by Sector
        filter = {"linktable": "project_theme_sector",
                  "lkey": "theme_id",
                  "rkey": "sector_id",
                  "values": values
                  }
        )

    resource = s3db.resource("project_project")
    instance, fieldname, field = widget.resolve(resource)
    
    value = widget.extract(resource, record_id=None)
    output = widget(s3db.project_theme_project.theme_id,
                    value,
                    _name=field.name)

    return output

# -----------------------------------------------------------------------------
def hazard():
    """ RESTful CRUD controller """

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def framework():
    """ RESTful CRUD controller """

    return s3_rest_controller(dtargs={"dt_text_maximum_len": 160},
                              hide_filter=True,
                             )

# =============================================================================
def organisation():
    """ RESTful CRUD controller """

    if settings.get_project_multiple_organisations():
        # e.g. IFRC
        s3db.configure("project_organisation",
                       insertable=False,
                       editable=False,
                       deletable=False)

        #list_btn = A(T("Funding Report"),
        #             _href=URL(c="project", f="organisation",
        #                      args="report", vars=get_vars),
        #             _class="action-btn")

        return s3_rest_controller(#list_btn=list_btn,
                                  )

    else:
        # e.g. DRRPP
        tabs = [(T("Basic Details"), None),
                (T("Projects"), "project"),
                (T("Contacts"), "human_resource"),
                ]
        rheader = lambda r: s3db.org_rheader(r, tabs)
        return s3_rest_controller("org", resourcename,
                                  rheader=rheader)

# =============================================================================
def beneficiary_type():
    """ RESTful CRUD controller """

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def beneficiary():
    """ RESTful CRUD controller """

    # Normally only used in Report
    # - make changes as component of Project
    s3db.configure("project_beneficiary",
                   deletable = False,
                   editable = False,
                   insertable = False,
                   )

    list_btn = A(T("Beneficiary Report"),
                 _href=URL(c="project", f="beneficiary",
                           args="report", vars=get_vars),
                 _class="action-btn")

    #def prep(r):
    #    if r.method in ("create", "create.popup", "update", "update.popup"):
    #        # Coming from Profile page?
    #        location_id = r.get_vars.get("~.(location)", None)
    #        if location_id:
    #            field = r.table.location_id
    #            field.default = location_id
    #            field.readable = field.writable = False
    #    if r.record:
    #        field = r.table.location_id
    #        field.comment = None
    #        field.writable = False
    #    return True
    #s3.prep = prep

    return s3_rest_controller(hide_filter=False)

# =============================================================================
def activity_type():
    """ RESTful CRUD controller """

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def activity_type_sector():
    """ RESTful CRUD controller for options.s3json lookups """

    if auth.permission.format != "s3json":
        return ""

    # Pre-process
    def prep(r):
        if r.method != "options":
            return False
        return True
    s3.prep = prep

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def activity_organisation():
    """ RESTful CRUD controller for options.s3json lookups """

    if auth.permission.format != "s3json":
        return ""

    # Pre-process
    def prep(r):
        if r.method != "options":
            return False
        return True
    s3.prep = prep

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def activity():
    """ RESTful CRUD controller """

    table = s3db.project_activity

    if "project_id" in get_vars:
        field = table.project_id
        field.default = get_vars.project_id
        field.writable = False
        field.comment = None

    # Pre-process
    def prep(r):
        if r.interactive:
            if r.component is not None:
                if r.component_name == "document":
                    doc_table = s3db.doc_document
                    doc_table.organisation_id.readable = doc_table.organisation_id.writable = False
                    doc_table.person_id.readable = doc_table.person_id.writable = False
                    doc_table.location_id.readable = doc_table.location_id.writable = False
        return True
    s3.prep = prep

    return s3_rest_controller(csv_template = "activity",
                              hide_filter = False,
                              rheader = s3db.project_rheader,
                              )

# -----------------------------------------------------------------------------
def location():
    """ RESTful CRUD controller """

    table = s3db.project_location

    # Pre-process
    def prep(r):
        if r.interactive:
            if r.record:
                table = s3db.project_sector_project
                query = (table.project_id == r.record.project_id) & \
                        (table.deleted == False)
                rows = db(query).select(table.sector_id)
                sector_ids = [row.sector_id for row in rows]
            else:
                sector_ids = []
            set_activity_type_requires("project_activity_type_location", sector_ids)

            if r.component_name == "document":
                table = db.doc_document
                table.organisation_id.readable = table.organisation_id.writable = False
                table.person_id.readable = table.person_id.writable = False
                table.location_id.readable = table.location_id.writable = False

        return True
    s3.prep = prep

    # Pre-process
    def postp(r, output):
        if r.representation == "plain":
            # Replace the Map Popup contents with custom content
            item = TABLE()
            if settings.get_project_community():
                # The Community is the primary resource
                record = r.record
                table.id.readable = False
                table.location_id.readable = False
                fields = [table[f] for f in table.fields if table[f].readable]
                for field in fields:
                    data = record[field]
                    if data:
                        represent = field.represent
                        if represent:
                            item.append(TR(TD(field.label),
                                           TD(represent(data))))
                        else:
                            item.append(TR(TD(field.label), TD(data)))
                hierarchy = gis.get_location_hierarchy()
                gtable = s3db.gis_location
                location = db(gtable.id == record.location_id).select(gtable.L1,
                                                                      gtable.L2,
                                                                      gtable.L3,
                                                                      gtable.L4,
                                                                      ).first()
                if location:
                    for field in ["L4", "L3", "L2", "L1"]:
                        if field in hierarchy and location[field]:
                            item.append(TR(TD(hierarchy[field]),
                                           TD(location[field])))
                output["item"] = item
            else:
                # The Project is the primary resource
                project_id = r.record.project_id
                ptable = s3db.project_project
                query = (ptable.id == project_id)
                project = db(query).select(limitby=(0, 1)).first()
                ptable.id.readable = False
                fields = [ptable[f] for f in ptable.fields if ptable[f].readable]
                for field in fields:
                    if field == "currency":
                        # Don't display Currency if no Budget
                        if not project["budget"]:
                            continue
                    data = project[field]
                    if data:
                        represent = field.represent
                        if represent:
                            item.append(TR(TD(field.label),
                                           TD(represent(data))))
                        else:
                            item.append(TR(TD(field.label), TD(data)))
                title = s3.crud_strings["project_project"].title_display
                # Assume authorised to see details
                popup_url = URL(f="project", args=[project_id])
                details_btn = A(T("Open"),
                                _href=popup_url,
                                _class="btn",
                                _id="details-btn",
                                _target="_blank")
                output = dict(item = item,
                              title = title,
                              details_btn = details_btn,
                              )
        return output
    s3.postp = postp

    return s3_rest_controller(interactive_report=True,
                              rheader=s3db.project_rheader,
                              hide_filter=False,
                              csv_template="location",
                              )

# -----------------------------------------------------------------------------
def demographic():
    """ RESTful CRUD controller """

    return s3_rest_controller("stats", "demographic")

# -----------------------------------------------------------------------------
def demographic_data():
    """ RESTful CRUD controller """

    return s3db.stats_demographic_data_controller()

# -----------------------------------------------------------------------------
def location_contact():
    """ RESTful CRUD controller for Community Contacts """

    return s3_rest_controller(hide_filter=False)

# -----------------------------------------------------------------------------
def report():
    """
        RESTful CRUD controller

        @ToDo: Why is this needed? To have no rheader?
    """

    return s3_rest_controller(module, "activity")

# -----------------------------------------------------------------------------
def partners():
    """
        RESTful CRUD controller for Organisations filtered by Type
    """

    # @ToDo: This could need to be a deployment setting
    get_vars["organisation_type.name"] = \
        "Academic,Bilateral,Government,Intergovernmental,NGO,UN agency"

    # Load model
    table = s3db.org_organisation

    # Modify CRUD Strings
    s3.crud_strings.org_organisation = Storage(
        label_create = T("Create Partner Organization"),
        title_display = T("Partner Organization Details"),
        title_list = T("Partner Organizations"),
        title_update = T("Edit Partner Organization"),
        title_upload = T("Import Partner Organizations"),
        label_list_button = T("List Partner Organizations"),
        label_delete_button = T("Delete Partner Organization"),
        msg_record_created = T("Partner Organization added"),
        msg_record_modified = T("Partner Organization updated"),
        msg_record_deleted = T("Partner Organization deleted"),
        msg_list_empty = T("No Partner Organizations currently registered")
        )

    return s3db.org_organisation_controller()

# =============================================================================
def task():
    """ RESTful CRUD controller """

    return s3db.project_task_controller()

# =============================================================================
def task_project():
    """ RESTful CRUD controller for options.s3json lookups """

    if auth.permission.format != "s3json":
        return ""

    # Pre-process
    def prep(r):
        if r.method != "options":
            return False
        return True
    s3.prep = prep

    return s3_rest_controller()

# =============================================================================
def task_activity():
    """ RESTful CRUD controller for options.s3json lookups """

    if auth.permission.format != "s3json":
        return ""

    # Pre-process
    def prep(r):
        if r.method != "options":
            return False
        return True
    s3.prep = prep

    return s3_rest_controller()

# =============================================================================
def task_milestone():
    """ RESTful CRUD controller for options.s3json lookups """

    if auth.permission.format != "s3json":
        return ""

    # Pre-process
    def prep(r):
        if r.method != "options":
            return False
        return True
    s3.prep = prep

    return s3_rest_controller()

# =============================================================================
def milestone():
    """ RESTful CRUD controller """

    if "project_id" in get_vars:
        field = s3db.project_milestone.project_id
        field.default = get_vars.project_id
        field.writable = False
        field.comment = None

    return s3_rest_controller()

# =============================================================================
def time():
    """ RESTful CRUD controller """

    # Load model to get normal CRUD strings
    table = s3db.project_time
    hide_filter = False
    if "mine" in get_vars:
        # Display this user's Logged Hours in reverse-order
        hide_filter = True
        s3.crud_strings["project_time"].title_list = T("My Logged Hours")
        person_id = auth.s3_logged_in_person()
        if person_id:
            # @ToDo: Use URL filter instead, but the Search page will have 
            # to populate it's widgets based on the URL filter  
            s3.filter = (table.person_id == person_id)
            # Log time with just this user's open tasks visible
            ttable = db.project_task
            query = (ttable.pe_id == auth.user.pe_id) & \
                    (ttable.deleted == False)
            if "update" not in request.args:
                # Only log time against Open Tasks
                query &= (ttable.status.belongs(s3db.project_task_active_statuses))
            dbset = db(query)
            table.task_id.requires = IS_ONE_OF(dbset, "project_task.id",
                                               s3db.project_task_represent_w_project
                                               )
        list_fields = ["id",
                       "date",
                       "hours",
                       (T("Project"), "task_id$task_project.project_id"),
                       (T("Activity"), "task_id$task_activity.activity_id"),
                       "task_id",
                       "comments",
                       ]
        if settings.get_project_milestones():
            # Use the field in this format to get the custom represent
            list_fields.insert(5, (T("Milestone"), "task_id$task_milestone.milestone_id"))

        s3db.configure("project_time",
                       orderby="project_time.date desc",
                       list_fields=list_fields)

    elif "week" in get_vars:
        # Filter to the specified number of weeks
        weeks = int(get_vars.get("week", 1))
        now = request.utcnow
        week = datetime.timedelta(days=7)
        delta = week * weeks
        s3.filter = (table.date > (now - delta))

    elif "month" in get_vars:
        # Filter to the specified number of months
        months = int(get_vars.get("month", 1))
        now = request.utcnow
        month = datetime.timedelta(weeks=4)
        delta = month * months
        s3.filter = (table.date > (now - delta))

    return s3_rest_controller(hide_filter=hide_filter)

# =============================================================================
# Comments
# =============================================================================
def comment_parse(comment, comments, task_id=None):
    """
        Parse a Comment

        @param: comment - a gluon.sql.Row: the current comment
        @param: comments - a gluon.sql.Rows: full list of comments
        @param: task_id - a reference ID: optional task commented on
    """

    author = B(T("Anonymous"))
    if comment.created_by:
        utable = s3db.auth_user
        ptable = s3db.pr_person
        ltable = s3db.pr_person_user
        query = (utable.id == comment.created_by)
        left = [ltable.on(ltable.user_id == utable.id),
                ptable.on(ptable.pe_id == ltable.pe_id)]
        row = db(query).select(utable.email,
                               ptable.first_name,
                               ptable.middle_name,
                               ptable.last_name,
                               left=left, limitby=(0, 1)).first()
        if row:
            person = row.pr_person
            user = row[utable._tablename]
            username = s3_fullname(person)
            email = user.email.strip().lower()
            import hashlib
            hash = hashlib.md5(email).hexdigest()
            url = "http://www.gravatar.com/%s" % hash
            author = B(A(username, _href=url, _target="top"))
    if not task_id and comment.task_id:
        table = s3db.project_task
        task = "re: %s" % table[comment.task_id].name
        header = DIV(author, " ", task)
        task_id = comment.task_id
    else:
        header = author
    thread = LI(DIV(s3base.s3_avatar_represent(comment.created_by),
                    DIV(DIV(header,
                            _class="comment-header"),
                        DIV(XML(comment.body)),
                        _class="comment-text"),
                        DIV(DIV(comment.created_on,
                                _class="comment-date"),
                            DIV(A(T("Reply"),
                                  _class="action-btn"),
                                _onclick="comment_reply(%i);" % comment.id,
                                _class="comment-reply"),
                            _class="fright"),
                    _id="comment-%i" % comment.id,
                    _task_id=task_id,
                    _class="comment-box"))

    # Add the children of this thread
    children = UL(_class="children")
    id = comment.id
    count = 0
    for comment in comments:
        if comment.parent == id:
            count = 1
            child = comment_parse(comment, comments, task_id=task_id)
            children.append(child)
    if count == 1:
        thread.append(children)

    return thread

# -----------------------------------------------------------------------------
def comments():
    """ Function accessed by AJAX from rfooter to handle Comments """

    try:
        task_id = request.args[0]
    except:
        raise HTTP(400)

    table = s3db.project_comment
    field = table.task_id
    field.default = task_id
    field.writable = field.readable = False

    # Form to add a new Comment
    # @ToDo: Rewrite using SQLFORM or S3SQLCustomForm
    from gluon.tools import Crud
    # =============================================================================
    class CrudS3(Crud):
        """
            S3 extension of the gluon.tools.Crud class
            - select() uses SQLTABLES3 (to allow different linkto construction)
        """

        def __init__(self):
            """ Initialise parent class & make any necessary modifications """
            Crud.__init__(self, current.db)


        def select(
            self,
            table,
            query=None,
            fields=None,
            orderby=None,
            limitby=None,
            headers={},
            **attr):

            db = current.db
            request = current.request
            if not (isinstance(table, db.Table) or table in db.tables):
                raise HTTP(404)
            if not self.has_permission("select", table):
                redirect(current.auth.settings.on_failed_authorization)
            #if record_id and not self.has_permission("select", table):
            #    redirect(current.auth.settings.on_failed_authorization)
            if not isinstance(table, db.Table):
                table = db[table]
            if not query:
                query = table.id > 0
            if not fields:
                fields = [table.ALL]
            rows = db(query).select(*fields, **dict(orderby=orderby,
                limitby=limitby))
            if not rows:
                return None # Nicer than an empty table.
            if not "linkto" in attr:
                attr["linkto"] = self.url(args="read")
            if not "upload" in attr:
                attr["upload"] = self.url("download")
            if request.extension != "html":
                return rows.as_list()
            return SQLTABLES3(rows, headers=headers, **attr)

    # =============================================================================
    class SQLTABLES3(SQLTABLE):
        """
            S3 custom version of gluon.sqlhtml.SQLTABLE

            Given a SQLRows object, as returned by a db().select(), generates
            an html table with the rows.

                - we need a different linkto construction for our CRUD controller
                - we need to specify a different ID field to direct to for the M2M controller
                - used by S3Resource.sqltable

            Optional arguments:

            @keyword linkto: URL (or lambda to generate a URL) to edit individual records
            @keyword upload: URL to download uploaded files
            @keyword orderby: Add an orderby link to column headers.
            @keyword headers: dictionary of headers to headers redefinions
            @keyword truncate: length at which to truncate text in table cells.
                Defaults to 16 characters.

            Optional names attributes for passed to the <table> tag

            Simple linkto example::

                rows = db.select(db.sometable.ALL)
                table = SQLTABLES3(rows, linkto="someurl")

            This will link rows[id] to .../sometable/value_of_id

            More advanced linkto example::

                def mylink(field):
                    return URL(args=[field])

                rows = db.select(db.sometable.ALL)
                table = SQLTABLES3(rows, linkto=mylink)

            This will link rows[id] to::

                current_app/current_controller/current_function/value_of_id
        """

        def __init__(self, sqlrows,
                     linkto=None,
                     upload=None,
                     orderby=None,
                     headers={},
                     truncate=16,
                     columns=None,
                     th_link="",
                     **attributes):

            # reverted since it causes errors (admin/user & manual importing of req/req/import)
            # super(SQLTABLES3, self).__init__(**attributes)
            TABLE.__init__(self, **attributes)

            self.components = []
            self.attributes = attributes
            self.sqlrows = sqlrows
            (components, row) = (self.components, [])
            if not columns:
                columns = sqlrows.colnames
            if headers=="fieldname:capitalize":
                headers = {}
                for c in columns:
                    headers[c] = " ".join([w.capitalize() for w in c.split(".")[-1].split("_")])
            elif headers=="labels":
                headers = {}
                for c in columns:
                    (t, f) = c.split(".")
                    field = sqlrows.db[t][f]
                    headers[c] = field.label

            if headers!=None:
                for c in columns:
                    if orderby:
                        row.append(TH(A(headers.get(c, c),
                                        _href=th_link+"?orderby=" + c)))
                    else:
                        row.append(TH(headers.get(c, c)))
                components.append(THEAD(TR(*row)))

            tbody = []
            table_field = re.compile("[\w_]+\.[\w_]+")
            for (rc, record) in enumerate(sqlrows):
                row = []
                if rc % 2 == 0:
                    _class = "even"
                else:
                    _class = "odd"
                for colname in columns:
                    if not table_field.match(colname):
                        if "_extra" in record and colname in record._extra:
                            r = record._extra[colname]
                            row.append(TD(r))
                            continue
                        else:
                            raise KeyError("Column %s not found (SQLTABLE)" % colname)
                    (tablename, fieldname) = colname.split(".")
                    try:
                        field = sqlrows.db[tablename][fieldname]
                    except (KeyError, AttributeError):
                        field = None
                    if tablename in record \
                            and isinstance(record, Row) \
                            and isinstance(record[tablename], Row):
                        r = record[tablename][fieldname]
                    elif fieldname in record:
                        r = record[fieldname]
                    else:
                        raise SyntaxError("something wrong in Rows object")
                    r_old = r
                    if not field:
                        pass
                    elif linkto and field.type == "id":
                        #try:
                            #href = linkto(r, "table", tablename)
                        #except TypeError:
                            #href = "%s/%s/%s" % (linkto, tablename, r_old)
                        #r = A(r, _href=href)
                        try:
                            href = linkto(r)
                        except TypeError:
                            href = "%s/%s" % (linkto, r)
                        r = A(r, _href=href)
                    #elif linkto and field.type.startswith("reference"):
                        #ref = field.type[10:]
                        #try:
                            #href = linkto(r, "reference", ref)
                        #except TypeError:
                            #href = "%s/%s/%s" % (linkto, ref, r_old)
                            #if ref.find(".") >= 0:
                                #tref,fref = ref.split(".")
                                #if hasattr(sqlrows.db[tref],"_primarykey"):
                                    #href = "%s/%s?%s" % (linkto, tref, urllib.urlencode({fref:r}))
                        #r = A(str(r), _href=str(href))
                    elif linkto \
                         and hasattr(field._table, "_primarykey") \
                         and fieldname in field._table._primarykey:
                        # have to test this with multi-key tables
                        key = urllib.urlencode(dict([ \
                                    ((tablename in record \
                                          and isinstance(record, Row) \
                                          and isinstance(record[tablename], Row)) \
                                          and (k, record[tablename][k])) \
                                          or (k, record[k]) \
                                        for k in field._table._primarykey]))
                        r = A(r, _href="%s/%s?%s" % (linkto, tablename, key))
                    elif field.type.startswith("list:"):
                        r = field.represent(r or [])
                    elif field.represent:
                        r = field.represent(r)
                    elif field.type.startswith("reference"):
                        pass
                    elif field.type == "blob" and r:
                        r = "DATA"
                    elif field.type == "upload":
                        if upload and r:
                            r = A("file", _href="%s/%s" % (upload, r))
                        elif r:
                            r = "file"
                        else:
                            r = ""
                    elif field.type in ["string", "text"]:
                        r = str(field.formatter(r))
                        ur = unicode(r, "utf8")
                        if truncate!=None and len(ur) > truncate:
                            r = ur[:truncate - 3].encode("utf8") + "..."
                    row.append(TD(r))
                tbody.append(TR(_class=_class, *row))
            components.append(TBODY(*tbody))

    crud = CrudS3()
    crud.messages.submit_button = T("Save")
    form = crud.create(table, formname="project_comment/%s" % task_id)

    # List of existing Comments
    comments = db(field == task_id).select(table.id,
                                           table.parent,
                                           table.body,
                                           table.created_by,
                                           table.created_on)

    output = UL(_id="comments")
    for comment in comments:
        if not comment.parent:
            # Show top-level threads at top-level
            thread = comment_parse(comment, comments, task_id=task_id)
            output.append(thread)

    script = "".join((
'''$('#comments').collapsible({xoffset:'-5',yoffset:'50',imagehide:img_path+'arrow-down.png',imageshow:img_path+'arrow-right.png',defaulthide:false})
$('#project_comment_parent__row1').hide()
$('#project_comment_parent__row').hide()
$('#project_comment_body').ckeditor(ck_config)
$('#submit_record__row input').click(function(){
 $('#comment-form').hide()
 $('#project_comment_body').ckeditorGet().destroy()
 return true
})'''))

    # No layout in this output!
    #s3.jquery_ready.append(script)

    output = DIV(output,
                 DIV(H4(T("New Post"),
                        _id="comment-title"),
                     form,
                     _id="comment-form",
                     _class="clear"),
                 SCRIPT(script))

    return XML(output)

# =============================================================================
# Campaigns
# =============================================================================
def campaign():
    """ RESTful CRUD controller """

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def campaign_keyword():
    """ RESTful CRUD controller """

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def campaign_message():
    """ RESTful CRUD controller """

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def campaign_response():
    """ RESTful CRUD controller """

    return s3_rest_controller()

# -----------------------------------------------------------------------------
def campaign_response_summary():
    """ RESTful CRUD controller """

    return s3_rest_controller()

# END =========================================================================