theme.h

/*
** Copyright 2014-2016 The Earlham Institute
**
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
**
**     http://www.apache.org/licenses/LICENSE-2.0
**
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
/*
 * theme.h
 *
 *  Created on: 28 Sep 2016
 *      Author: billy
 */

#ifndef THEME_H_
#define THEME_H_

#include "mod_dav.h"
#include "apr_buckets.h"
#include "apr_tables.h"

//#include "irods/rodsType.h"
//#include "irods/rodsConnect.h"


#include "listing.h"
#include "config.h"


enum MetadataDisplay
{
	MD_UNSET,
	MD_NONE,
	MD_FULL,
	MD_ON_DEMAND,
	MD_NUM_ENTRIES
};



typedef enum Placement
{
	PL_HEAD,
	PL_IN_HEADER,
	PL_PRE_LISTINGS,
	PL_POST_LISTINGS,
	PL_IN_FOOTER,
	PL_NUM_ENTRIES
} Placement;



struct HtmlTheme
{
	const char *ht_head_s;

	const char *ht_top_s;

	const char *ht_bottom_s;

	const char *ht_collection_icon_s;

	const char *ht_object_icon_s;

	const char *ht_listing_class_s;

	enum MetadataDisplay ht_show_metadata_flag;

	int ht_metadata_editable_flag;

	const char *ht_add_metadata_icon_s;

	const char *ht_edit_metadata_icon_s;

	const char *ht_delete_metadata_icon_s;

	const char *ht_download_metadata_icon_s;

	const char *ht_download_metadata_as_csv_icon_s;

	const char *ht_download_metadata_as_json_icon_s;

	const char *ht_view_metadata_icon_s;

	int ht_show_download_metadata_links_flag;

	const char *ht_ok_icon_s;

	const char *ht_cancel_icon_s;

	const char *ht_rest_api_s;

	char **ht_resources_ss;

	int ht_show_resource_flag;

	int ht_show_ids_flag;

	int ht_show_checksums_flag;

	int ht_active_flag;

	const char *ht_login_url_s;

	const char *ht_logout_url_s;

	const char *ht_user_icon_s;

	apr_table_t *ht_icons_map_p;


	const char *ht_name_heading_s;

	const char *ht_size_heading_s;

	const char *ht_owner_heading_s;

	const char *ht_date_heading_s;

	const char *ht_properties_heading_s;

	const char *ht_checksum_heading_s;

	const char *ht_zone_label_s;

	const char *ht_pre_table_html_s;

	const char *ht_post_table_html_s;

	const char *ht_pre_close_body_html_s;

	int ht_add_search_form_flag;

	int ht_show_fd_data_packages_flag;

	Placement ht_tools_placement;

	const char *ht_fd_resource_name_key_s;

	const char *ht_fd_resource_license_name_key_s;

	const char *ht_fd_resource_license_url_key_s;

	const char *ht_fd_resource_title_key_s;

	const char *ht_fd_resource_id_key_s;

	const char *ht_fd_resource_authors_key_s;

	const char *ht_fd_resource_description_key_s;

	const char *ht_fd_resource_data_package_icon_s;

	int ht_fd_save_datapackages_flag;
};



#ifdef ALLOCATE_THEME_CONSTANTS
#define THEME_PREFIX
#define THEME_VAL(x) = x
#else
#define THEME_PREFIX extern
#define THEME_VAL(x)
#endif


THEME_PREFIX const char THEME_HIDE_COLUMN_S [] THEME_VAL ("!");


THEME_PREFIX const char * const CONTENT_TYPE_JSON_S THEME_VAL ("application/json");


/* forward declaration */
struct davrods_dir_conf;


#ifdef __cplusplus
extern "C"
{
#endif



struct HtmlTheme * AllocateHtmlTheme (apr_pool_t *pool_p);

dav_error *DeliverThemedDirectory (const dav_resource *resource_p, ap_filter_t *output_p);

apr_status_t PrintItem (struct HtmlTheme *theme_p, const IRodsObject *irods_obj_p, const IRodsConfig *config_p, unsigned int row_index, apr_bucket_brigade *bb_p, apr_pool_t *pool_p, rcComm_t *connection_p, request_rec *req_p);

apr_status_t PrintAllHTMLBeforeListing (struct dav_resource_private *davrods_resource_p, const char *escaped_zone_s, const char * const page_title_s, const char *davrods_path_s, const char * const marked_up_page_title_s, char *current_id_s, const char * const user_s, davrods_dir_conf_t *conf_p, request_rec *req_p, apr_bucket_brigade *bucket_brigade_p, apr_pool_t *pool_p);

apr_status_t PrintAllHTMLAfterListing (const char *user_s, const char *escaped_zone_s, const char *davrods_path_s, const davrods_dir_conf_t *conf_p, char *current_id_s, rcComm_t *connection_p, request_rec *req_p, apr_bucket_brigade *bucket_brigade_p, apr_pool_t *pool_p);

void MergeThemeConfigs (davrods_dir_conf_t *conf_p, davrods_dir_conf_t *parent_p, davrods_dir_conf_t *child_p, apr_pool_t *pool_p);

char *GetLocationPath (request_rec *req_p, davrods_dir_conf_t *conf_p, apr_pool_t *pool_p, const char *needle_s);

char *GetDavrodsAPIPath (struct dav_resource_private *davrods_resource_p, davrods_dir_conf_t *conf_p, request_rec *req_p);

int GetEditableFlag (const struct HtmlTheme  * const theme_p, apr_table_t *params_p, apr_pool_t *pool_p);

const char *SetHeadHTML (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetTopHTML (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetBottomHTML (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetCollectionImage (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetObjectImage (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetTableListingClass (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetShowThemedListings (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetShowResources (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetShowSelectedResourcesOnly (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetMetadataDisplay (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetMetadataIsEditable (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetShowIds (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetLoginURL (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetLogoutURL (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetUserImage (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetAddMetadataImage (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetDownloadMetadataImage (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetDownloadMetadataImageAsJSON (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetDownloadMetadataImageAsCSV (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetDeleteMetadataImage (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetEditMetadataImage (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetOkImage (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetCancelImage (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetAPIPath (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetViewsPath (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetDefaultUsername (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetDefaultPassword (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetIconForSuffix (cmd_parms *cmd_p, void *config_p, const char *icon_s, const char *suffix_s);

const char *SetExposedRootForSpecifiedUser (cmd_parms *cmd_p, void *config_p, const char *username_s, const char *exposed_root_s);

const char *SetShowMetadataSearchForm (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetShowMetadataDownloadLinks (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetNameHeading (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetSizeHeading (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetOwnerHeading (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetDateHeading (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetPropertiesHeading (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetChecksumHeading (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetZoneLabel (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetPreListingsHTML (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetPostListingsHTML (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetPreCloseBodyHTML (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetToolsPlacement (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetShowChecksum (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetShowFDDataPackages (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetFDNameKey (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetFDLicenseNameKey (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetFDLicenseUrlKey (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetFDTitleKey (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetFDIdKey (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetFDDescriptionKey (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetFDAuthorsKey (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetFDDataPackageImage (cmd_parms *cmd_p, void *config_p, const char *arg_p);

const char *SetSaveFDDataPackages (cmd_parms *cmd_p, void *config_p, const char *arg_p);


#ifdef __cplusplus
}
#endif

#endif /* THEME_H_ */