note description: "Summary description for {WDOCS_EDIT_FORM_RESPONSE}." date: "$Date$" revision: "$Revision$" class WDOCS_EDIT_FORM_RESPONSE inherit CMS_RESPONSE rename make as make_response end WDOCS_MODULE_HELPER rename percent_encoder as wdocs_percent_encoder end create make feature {NONE} -- Initialization make (req: WSF_REQUEST; res: WSF_RESPONSE; a_api: like api; a_wdocs_api: WDOCS_API; a_wdocs_edit_module: WDOCS_EDIT_MODULE) do wdocs_api := a_wdocs_api wdocs_module := a_wdocs_edit_module.wdocs_module make_response (req, res, a_api) end feature -- Access wdocs_api: WDOCS_API wdocs_module: WDOCS_MODULE feature -- Execution wiki_page_info_from_request: detachable TUPLE [page: attached like {WDOCS_MANAGER}.page; bookid: READABLE_STRING_GENERAL; manager: WDOCS_MANAGER] do Result := wdocs_module.wikipage_data_from_request (request) end wiki_page_from_request: detachable WIKI_BOOK_PAGE do Result := wdocs_module.wikipage_from_request (request) end process -- Computed response message. local b: STRING_8 fd: detachable WSF_FORM_DATA f: like new_edit_form new_pg,pg: detachable WIKI_BOOK_PAGE mng: WDOCS_MANAGER lab: detachable READABLE_STRING_32 l_bookid: detachable READABLE_STRING_GENERAL l_text: STRING l_preview: BOOLEAN do create b.make_empty if attached wiki_page_info_from_request as pg_info then pg := pg_info.page mng := pg_info.manager l_bookid := pg_info.bookid else if attached {WSF_STRING} request.path_parameter ("bookid") as p_bookid then l_bookid := p_bookid.value end if attached {WSF_STRING} request.path_parameter ("version") as p_version then mng := wdocs_api.manager (p_version.value) else mng := wdocs_api.manager (Void) end end if location.ends_with_general ("/edit") and then has_permission ({WDOCS_EDIT_MODULE}.perm_edit_wdocs_page) then lab := wdocs_api.label_of_version (wdocs_api.default_version_id) if lab = Void then lab := "current" end if mng.version_id.is_case_insensitive_equal (wdocs_api.default_version_id) then add_notice_message ("You are editing " + api.html_encoded (lab) + " version [" + api.html_encoded (mng.version_id) + "].") else add_warning_message ("You are editing version [" + api.html_encoded (mng.version_id) + "], which is NOT the " + api.html_encoded (lab) + " version [" + api.html_encoded (wdocs_api.default_version_id) + "]!") end if pg /= Void then set_title (formatted_string (translation ("Edit %"$1%"", Void), [pg.title])) add_to_primary_tabs (create {CMS_LOCAL_LINK}.make ("View", view_location)) else set_title (translation ("New doc page", Void)) end f := new_edit_form (pg, mng, url (request.percent_encoded_path_info, Void), "wdocs_edit") if l_bookid /= Void then f.extend (create {WSF_FORM_HIDDEN_INPUT}.make_with_text ("bookid", l_bookid.as_string_32)) end api.hooks.invoke_form_alter (f, fd, Current) if request.is_post_request_method then if l_bookid = Void then add_error_message ("Missing book name information!") else f.validation_actions.extend (agent edit_form_validate (?, pg, mng, b)) f.submit_actions.extend (agent edit_form_submit (?, mng, pg, l_bookid, b)) f.process (Current) fd := f.last_data if fd /= Void and then fd.is_valid then l_preview := attached {WSF_STRING} fd.item ("op") as l_op and then l_op.same_string ("Preview") if l_preview then f.append_to_html (wsf_theme, b) else if pg /= Void then if mng.is_default_version then set_redirection (mng.wiki_page_uri_path (pg, l_bookid, Void)) else set_redirection (mng.wiki_page_uri_path (pg, l_bookid, mng.version_id)) end else set_redirection (view_location) end end else f.append_to_html (wsf_theme, b) end end else f.append_to_html (wsf_theme, b) end elseif location.ends_with_general ("/add-child") and then has_permission ({WDOCS_EDIT_MODULE}.perm_create_wdocs_page) and then l_bookid /= Void and then not l_bookid.is_empty -- FIXME: remove and handle the new Book creation. then -- if l_bookid = Void or else l_bookid.is_empty then -- -- Create new book -- set_title (translation ("Create Book", Void)) -- pg := Void -- else if pg /= Void then set_title (formatted_string (translation ("Add child to doc page %"$1%"", Void), [pg.title])) else set_title (translation ("New doc page", Void)) end -- end if pg /= Void then new_pg := mng.new_wiki_child_page ("", pg) else if l_bookid /= Void and then not l_bookid.is_empty then new_pg := mng.new_wiki_page ("", utf_8_string (l_bookid)) else new_pg := mng.new_wiki_page ("", "") end end create l_text.make_empty if attached new_pg.metadata_table as tb then across tb as ic loop l_text.append ("[[Property:" + utf_8_string (ic.key) + ":" + utf_8_string (ic.item) + "]]%N") end end new_pg.set_text (create {WIKI_CONTENT_TEXT}.make_from_string (l_text)) f := new_edit_form (new_pg, mng, url (request.percent_encoded_path_info, Void), "wdocs_edit") if l_bookid /= Void then f.extend (create {WSF_FORM_HIDDEN_INPUT}.make_with_text ("bookid", l_bookid.as_string_32)) end if pg /= Void then f.extend (create {WSF_FORM_HIDDEN_INPUT}.make_with_text ("parent", pg.title)) end api.hooks.invoke_form_alter (f, fd, Current) if request.is_post_request_method then if l_bookid = Void then add_error_message ("Missing book name information!") f.append_to_html (wsf_theme, b) else f.validation_actions.extend (agent edit_form_validate (?, new_pg, mng, b)) f.submit_actions.extend (agent edit_form_submit (?, mng, new_pg, l_bookid, b)) f.process (Current) fd := f.last_data if fd /= Void and then fd.is_valid then b.append ("

View wiki page ") if mng.is_default_version then b.append (link (new_pg.title, mng.wiki_page_uri_path (new_pg, l_bookid, Void), Void)) else b.append (link (new_pg.title, mng.wiki_page_uri_path (new_pg, l_bookid, mng.version_id), Void)) end b.append (".

") if pg /= Void then b.append ("

Back to parent page ") b.append (link (pg.title, view_location, Void)) b.append (".

") else b.append ("

Back to ") b.append (link ("parent page", view_location, Void)) b.append (".

") end if mng.is_default_version then set_redirection (mng.wiki_page_uri_path (new_pg, l_bookid, Void)) else set_redirection (mng.wiki_page_uri_path (new_pg, l_bookid, mng.version_id)) end else f.append_to_html (wsf_theme, b) end end else f.append_to_html (wsf_theme, b) end else b.append ("

") b.append (translation ("Access denied", Void)) b.append ("

") end set_main_content (b) end view_location: STRING do create Result.make_from_string (location) if Result.ends_with_general ("/edit") then Result.remove_tail (5) elseif Result.ends_with_general ("/add-child") then Result.remove_tail (10) end end feature -- Form edit_form_validate (fd: WSF_FORM_DATA; pg: detachable WIKI_BOOK_PAGE; a_manager: WDOCS_MANAGER; b: STRING) local l_preview: BOOLEAN -- l_format: detachable CONTENT_FORMAT l_title: detachable READABLE_STRING_32 l_source: detachable READABLE_STRING_32 l_xhtml: READABLE_STRING_8 s32: STRING_32 do -- if fd.item ("bookid") = Void then -- fd.report_error ("Missing book name information!") -- end if attached {WSF_STRING} fd.item ("modification_date") as f_date then if pg /= Void and then attached pg.path as l_path then if file_timestamp (l_path) /= f_date.value.to_integer then fd.report_error ("This document was modified by someone else, please " + link ("reload", location, Void) + ".") end end end l_preview := attached {WSF_STRING} fd.item ("op") as l_op and then l_op.same_string (translation ("Preview", Void)) if l_preview then b.append ("Preview
") l_title := fd.string_item ("title") l_source := fd.string_item ("source") if l_title /= Void and l_source /= Void then -- FIXME: workaround to handle CRNL as NL, as we had such issue. create s32.make_from_string (l_source) s32.prune_all ({CHARACTER_32} '%R') l_source := s32 l_xhtml := wiki_to_xhtml (wdocs_api, l_title, l_source, pg, a_manager) b.append ("Title:
" + html_encoded (l_title) + "
") b.append ("Content:
") b.append (l_xhtml) b.append ("
") end b.append ("
") else end end edit_form_submit (fd: WSF_FORM_DATA; a_manager: WDOCS_MANAGER; pg: detachable WIKI_BOOK_PAGE; a_bookid: READABLE_STRING_GENERAL; b: STRING) local l_preview: BOOLEAN l_path: detachable PATH l_page: detachable WIKI_BOOK_PAGE l_link_title_value, l_title_value, l_source_value: detachable READABLE_STRING_8 l_log_message: detachable READABLE_STRING_32 l_content: detachable READABLE_STRING_8 l_md_text: WDOCS_METADATA_WIKI_TEXT l_changed: BOOLEAN l_meta_title, l_meta_link_title, l_meta_uuid: detachable READABLE_STRING_32 s: STRING l_diff: DIFF_TEXT l_diff_text: detachable STRING l_mesg_text, l_mesg_title: STRING e: CMS_EMAIL fn: STRING_32 ctx: WDOCS_CHANGE_CONTEXT do l_preview := attached {WSF_STRING} fd.item ("op") as l_op and then l_op.same_string (translation ("Preview", Void)) if not l_preview then debug ("cms") across fd as c loop b.append ("
  • " + html_encoded (c.key) + "=") if attached c.item as v then b.append (html_encoded (v.string_representation)) end b.append ("
    • ") end end l_title_value := safe_utf_8_string (fd.string_item ("title")) l_link_title_value := safe_utf_8_string (fd.string_item ("link_title")) l_source_value := safe_utf_8_string (fd.string_item ("source")) l_log_message := fd.string_item ("log-msg") if l_source_value /= Void then create s.make_from_string (l_source_value) s.prune_all ('%R') l_source_value := s else l_source_value := Void end if location.ends_with_general ("/add-child") then if l_title_value /= Void and a_bookid /= Void then if pg /= Void then l_page := pg l_page.set_title (l_title_value) else l_page := wdocs_api.new_wiki_page (l_title_value, utf_8_string (a_bookid)) end l_changed := True end else if pg /= Void then l_meta_title := pg.metadata ("title") l_meta_link_title := pg.metadata ("link_title") l_meta_uuid := pg.metadata ("uuid") l_path := pg.path l_page := pg l_content := wdocs_api.wiki_text (pg) if attached pg.metadata_table as tb then tb.wipe_out end elseif l_title_value /= Void and a_bookid /= Void then l_page := wdocs_api.new_wiki_page (l_title_value, utf_8_string (a_bookid)) l_changed := True end end if l_page = Void or l_title_value = Void then b.append ("Can not create a new wiki doc. Not enough information!") else if l_source_value /= Void then l_changed := l_content = Void or else not l_content.same_string (l_source_value) l_page.set_text (create {WIKI_CONTENT_TEXT}.make_from_string (l_source_value)) create l_md_text.make_with_text (l_source_value) l_meta_title := l_md_text.item ("title") end if not l_page.title.same_string (l_title_value) then l_page.set_title (l_title_value) -- The "title" field was changed, it has priority over eventual changed wiki title property from content! l_page.set_metadata (l_title_value.to_string_32, "title") l_changed := True elseif l_meta_title /= Void and then not l_page.title.same_string_general (l_meta_title) then l_page.set_title (l_meta_title) -- The "title" metadata was changed, but not the title field. l_page.set_metadata (l_meta_title, "title") l_changed := True end if l_meta_link_title = Void or else l_meta_link_title.is_whitespace then if l_link_title_value /= Void and then not l_link_title_value.is_whitespace then l_page.set_metadata (l_link_title_value.to_string_32, "link_title") l_changed := True end else if l_link_title_value = Void or else l_link_title_value.is_whitespace then l_page.set_metadata (Void, "link_title") l_changed := True elseif not l_meta_link_title.same_string_general (l_link_title_value) then l_page.set_metadata (l_link_title_value.to_string_32, "link_title") l_changed := True end end if l_changed then if l_path = Void then if attached fd.string_item ("parent") as l_parent then if attached a_manager.page_by_title (l_parent, fd.string_item ("bookid")) as l_parent_page then l_path := l_parent_page.path if l_path /= Void then if l_parent_page.is_index_page then l_path := l_path.parent else fn := l_path.name if attached l_path.extension as ext then fn.remove_tail (1 + ext.count) end create l_path.make_from_string (fn) end end end end end l_page.update_from_metadata create ctx ctx.set_user (user) if l_log_message /= Void and then not l_log_message.is_empty then ctx.set_log (l_log_message + {STRING_32} "%NUpdated wikipage " + l_page.title + ".%N") else ctx.set_log ({STRING_32} "Updated wikipage " + l_page.title + ".") end wdocs_api.save_wiki_page (l_page, pg, l_source_value, l_path, a_bookid, a_manager, ctx) if wdocs_api.has_error then fd.report_error ("Error: could not save doc page!") add_error_message ("Error: could not save doc page!") else if l_source_value /= Void and l_content /= Void then create l_diff l_diff.set_text (l_content, l_source_value) l_diff.compute_diff l_diff_text := l_diff.unified add_notice_message (l_diff_text) end l_mesg_title := "Updated doc page %"" + l_page.title + "%"" l_mesg_title.append (" (version:" + utf_8_string (a_manager.version_id) + ")") create l_mesg_text.make_from_string ("Documentation page %"" + l_page.title + "%" was updated") if attached user as u then l_mesg_text.append (" (by ") l_mesg_text.append (utf_8_string (api.user_api.user_display_name (u))) l_mesg_text.append (")") l_mesg_title.append (" by ") l_mesg_title.append (utf_8_string (api.user_api.user_display_name (u))) end l_mesg_text.append (".%N%N") l_mesg_text.append ("- Version: " + api.html_encoded (a_manager.version_id) + "%N") l_mesg_text.append ("- Page location: " + api.site_url + view_location + "%N") if l_log_message /= Void then l_mesg_text.append ("- Log message: " + utf_8_string (l_log_message) + "%N") end l_mesg_text.append ("%N%N") -- FIXME: hardcoded link to admin wdocs clear-cache ! change that. add_warning_message ("You may need to " + link ("clear the cache", api.administration_path_location ("module/wdocs/clear-cache?destination=" + url_encoded (secured_url_content (view_location))), Void ) + ".") api.log ("wdocs", "Doc page changed", 0, create {CMS_LOCAL_LINK}.make (l_page.title, location)) add_success_message ("Doc page saved.") if l_diff_text /= Void and then not l_diff_text.is_whitespace then l_mesg_text.append ("Unified diff:%N%N") l_mesg_text.append (l_diff_text) elseif l_content /= Void then l_mesg_text.append ("Content:%N%N") l_mesg_text.append (l_content) end e := api.new_email (api.setup.site_email, l_mesg_title, l_mesg_text) b.append (l_mesg_text) b.append_character ('%N') api.process_email (e) -- set_redirection (view_location) end else b.append ("No change.") end end end end new_edit_form (pg: detachable WIKI_BOOK_PAGE; mng: WDOCS_MANAGER; a_url: READABLE_STRING_8; a_formid: STRING): CMS_FORM -- Create a web form named `a_formid' for wiki page `pg' (if set), using form action url `a_url'. local f: CMS_FORM tf: WSF_FORM_TEXTAREA f_title, f_link_title: WSF_FORM_TEXT_INPUT bt_preview, bt_save: WSF_FORM_SUBMIT_INPUT bt_reset: WSF_FORM_RESET_INPUT th: WSF_FORM_HIDDEN_INPUT fut: FILE_UTILITIES do create f.make (a_url, a_formid) f.set_method_post if pg /= Void then create th.make ("wiki_location") th.set_text_value (location.as_string_32) f.extend (th) end if pg /= Void then create f_title.make_with_text ("title", pg.title) else create f_title.make_with_text ("title", "") end f_title.set_size (40) f_title.set_validation_action (agent (fd: WSF_FORM_DATA) do if not attached fd.string_item ("title") as i_title or else i_title.is_whitespace then fd.report_invalid_field ("title", "Please set the title!") end end) -- f_title.set_placeholder ("Enter Page Title") f_title.set_label ("Title") f_title.set_description ("The page title will be used as wiki name for reference, such as [[WikiName|Text]].") f.extend (f_title) if pg /= Void and then attached pg.metadata ("link_title") as l_link_title then create f_link_title.make_with_text ("link_title", l_link_title) else create f_link_title.make_with_text ("link_title", "") end f_link_title.set_label ("Short Title") f_link_title.set_description ("Optional short title, used in menu or link.") f.extend (f_link_title) create tf.make ("source") tf.set_cols (90) tf.set_rows (25) tf.set_description ("[

    Put at the beginning of this content, the wiki properties [[Property:name|value]] which are used to set metadata such as: uuid, title, link_title, description, weight.

    Use wikitext formatting to provide the content.

    ]") tf.set_description_collapsible (False) tf.set_label ("Content") if pg /= Void then if attached wdocs_api.wiki_text (pg) as l_wiki_text then tf.set_text_value (utf_32_string (l_wiki_text)) else add_error_message ("Unable to retrieve related wiki text.") end if attached pg.path as l_path and then fut.file_path_exists (l_path) then create th.make_with_text ("modification_date", file_timestamp (l_path).out) f.extend (th) end end f.extend (tf) create tf.make ("log-msg") tf.set_label ("Log message") tf.set_cols (90) tf.set_rows (3) tf.set_description ("Briefly describe the changes you have made.") f.extend (tf) create bt_preview.make_with_text ("op", translation ("Preview", Void)) f.extend (bt_preview) create bt_save.make_with_text ("op", "Save") f.extend (bt_save) create bt_reset.make ("reset") f.extend (bt_reset) populate_form_with_taxonomy (Current, f, pg, mng) Result := f end populate_form_with_taxonomy (a_response: CMS_RESPONSE; a_form: CMS_FORM; a_page: detachable WIKI_PAGE; a_manager: WDOCS_MANAGER) local c: detachable CMS_WDOCS_CONTENT do if attached {CMS_TAXONOMY_API} a_response.api.module_api ({CMS_TAXONOMY_MODULE}) as l_taxonomy_api then if a_page /= Void and then attached wdocs_api.wiki_page_uuid (a_page, a_manager.version_id) as l_uuid then create {CMS_WDOCS_CONTENT} c.make (a_page, l_uuid) end l_taxonomy_api.populate_edit_form (a_response, a_form, {CMS_WDOCS_CONTENT_TYPE}.name, c) end end safe_utf_8_string (s: detachable READABLE_STRING_GENERAL): detachable STRING do if s /= Void then Result := utf_8_string (s) end end utf_8_string (s: READABLE_STRING_GENERAL): STRING local utf: UTF_CONVERTER do Result := utf.utf_32_string_to_utf_8_string_8 (s) end utf_32_string (s8: READABLE_STRING_8): STRING_32 local utf: UTF_CONVERTER do Result := utf.utf_8_string_8_to_string_32 (s8) end end