From 7188b3581a5ee865e8e392367bf86a3a2ef6fd79 Mon Sep 17 00:00:00 2001 From: iliajie Date: Fri, 12 May 2023 13:44:19 +0300 Subject: [PATCH] Add new `ui_paginations` API --- WebminCore.pm | 2 +- ui-lib.pl | 242 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 243 insertions(+), 1 deletion(-) diff --git a/WebminCore.pm b/WebminCore.pm index de253b085..3b1e7ddcb 100644 --- a/WebminCore.pm +++ b/WebminCore.pm @@ -23,7 +23,7 @@ $main::export_to_caller = 1; # Add functions in web-lib-funcs.pl # Generated with : # grep -h "^sub " web-lib-funcs.pl ui-lib.pl | sed -e 's/sub //' | xargs echo -@EXPORT = qw(read_file read_file_cached read_file_cached_with_stat write_file html_escape html_strip quote_escape quote_javascript tempname_dir tempname transname transname_timestamped trunc indexof indexoflc sysprint check_ipaddress check_ip6address generate_icon urlize un_urlize include copydata ReadParseMime ReadParse read_fully read_parse_mime_callback read_parse_mime_javascript PrintHeader header get_html_title get_html_framed_title get_html_status_line popup_header footer popup_footer load_module_preferences load_theme_library redirect kill_byname kill_byname_logged find_byname error popup_error register_error_handler call_error_handlers error_setup wait_for fast_wait_for has_command make_date file_chooser_button popup_window_button popup_window_link read_acl acl_filename acl_check get_miniserv_config_file get_miniserv_config put_miniserv_config restart_miniserv reload_miniserv check_os_support http_download complete_http_download http_post ftp_download ftp_upload no_proxy open_socket download_timeout ftp_command to_ipaddress to_ip6address to_hostname icons_table replace_meta replace_file_line read_file_lines flush_file_lines unflush_file_lines unix_user_input unix_group_input hlink user_chooser_button group_chooser_button foreign_check foreign_exists foreign_available foreign_require foreign_call foreign_config foreign_installed foreign_defined get_system_hostname get_webmin_version get_webmin_version_release get_webmin_full_version get_module_acl get_group_module_acl save_module_acl save_group_module_acl init_config load_language_auto load_language text_subs text encode_base64 decode_base64 encode_base32 decode_base32 get_module_info get_all_module_infos list_themes get_theme_info list_locales list_languages safe_language read_env_file write_env_file lock_file unlock_file test_lock unlock_all_files can_lock_file webmin_log additional_log var_dump webmin_debug_log system_logged backquote_logged backquote_with_timeout backquote_command kill_logged rename_logged rename_file symlink_logged symlink_file link_file make_dir make_dir_recursive set_ownership_permissions unlink_logged unlink_file copy_source_dest move_source_dest remote_session_name remote_foreign_require remote_foreign_call remote_foreign_check remote_foreign_config remote_eval remote_write remote_read remote_finished remote_error_setup remote_rpc_call remote_multi_callback remote_multi_callback_error serialise_variable unserialise_variable other_groups date_chooser_button help_file read_help_file seed_random disk_usage_kb recursive_disk_usage help_search_link make_http_connection validate_ssl_connection read_http_connection write_http_connection close_http_connection clean_environment reset_environment clean_language progress_callback switch_to_remote_user switch_to_unix_user eval_as_unix_user create_user_config_dirs create_missing_homedir filter_javascript resolve_links simplify_path same_file flush_webmin_caches list_usermods available_usermods get_available_module_infos get_visible_module_infos get_visible_modules_categories is_under_directory parse_http_url check_clicks_function load_entities_map entities_to_ascii get_product_name get_charset get_display_hostname save_module_config save_user_module_config nice_size get_perl_path get_goto_module select_all_link select_invert_link select_rows_link check_pid_file get_mod_lib module_root_directory list_mime_types guess_mime_type open_tempfile close_tempfile print_tempfile is_selinux_enabled get_clear_file_attributes reset_file_attributes cleanup_tempnames open_lock_tempfile END month_to_number number_to_month get_rbac_module_acl supports_rbac supports_ipv6 use_rbac_module_acl execute_command open_readfile open_execute_command translate_filename translate_command register_filename_callback register_command_callback capture_function_output capture_function_output_tempfile modules_chooser_button substitute_template substitute_pattern running_in_zone running_in_vserver running_in_xen running_in_openvz list_categories is_readonly_mode command_as_user list_osdn_mirrors convert_osdn_url get_current_dir supports_users supports_symlinks quote_path get_windows_root read_file_contents write_file_contents read_file_contents_limit unix_crypt split_quoted_string write_to_http_cache check_in_http_cache supports_javascript get_module_name get_module_variable clear_time_locale reset_time_locale callers_package web_libs_package get_userdb_string connect_userdb disconnect_userdb split_userdb_string uniquelc list_combined_webmin_menu list_modules_webmin_menu module_to_menu_item list_combined_system_info shell_is_bash compare_version_numbers convert_to_json convert_from_json print_json get_referer_relative get_webmin_email_url get_webmin_browser_url trim ui_link ui_help ui_img ui_link_button ui_table_start ui_table_end ui_table_row ui_table_hr ui_table_span ui_columns_start ui_columns_row ui_columns_header ui_checked_columns_row ui_radio_columns_row ui_columns_end ui_columns_table ui_form_columns_table ui_form_start ui_form_end ui_textbox ui_filebox ui_bytesbox ui_upload ui_password ui_hidden ui_select ui_multi_select ui_multi_select_javascript ui_radio ui_yesno_radio ui_checkbox ui_oneradio ui_textarea ui_user_textbox ui_users_textbox ui_group_textbox ui_groups_textbox ui_opt_textbox ui_submit ui_reset ui_button ui_date_input ui_buttons_start ui_buttons_end ui_buttons_row ui_buttons_hr ui_post_header ui_pre_footer ui_print_header ui_print_unbuffered_header ui_print_footer ui_config_link ui_print_endpage ui_subheading ui_links_row ui_hidden_javascript ui_hidden_start ui_hidden_end ui_hidden_table_row_start ui_hidden_table_row_end ui_hidden_table_start ui_hidden_table_end ui_tabs_start ui_tabs_end ui_tabs_start_tab ui_tabs_start_tabletab ui_tabs_end_tab ui_tabs_end_tabletab ui_max_text_width ui_radio_selector ui_radio_selector_javascript ui_grid_table ui_radio_table ui_up_down_arrows ui_hr ui_nav_link ui_confirmation_form ui_text_color ui_alert_box js_disable_inputs ui_page_flipper js_checkbox_disable js_redirect ui_webmin_link ui_line_break_double ui_page_refresh ui_details ui_div_row ui_paginations ui_hide_outside_of_viewport ui_read_file_contents_limit get_python_cmd get_buffer_size get_buffer_size_binary get_webprefix get_sub_ref_name setvar getvar delvar print_call_stack webmin_user_can_rpc webmin_user_login_mode webmin_user_is_admin webmin_user_is get_current_theme_info_cached miniserv_using_default_cert is_int float is_float parse_accepted_language get_default_system_locale create_wrapper); +@EXPORT = qw(read_file read_file_cached read_file_cached_with_stat write_file html_escape html_strip quote_escape quote_javascript tempname_dir tempname transname transname_timestamped trunc indexof indexoflc sysprint check_ipaddress check_ip6address generate_icon urlize un_urlize include copydata ReadParseMime ReadParse read_fully read_parse_mime_callback read_parse_mime_javascript PrintHeader header get_html_title get_html_framed_title get_html_status_line popup_header footer popup_footer load_module_preferences load_theme_library redirect kill_byname kill_byname_logged find_byname error popup_error register_error_handler call_error_handlers error_setup wait_for fast_wait_for has_command make_date file_chooser_button popup_window_button popup_window_link read_acl acl_filename acl_check get_miniserv_config_file get_miniserv_config put_miniserv_config restart_miniserv reload_miniserv check_os_support http_download complete_http_download http_post ftp_download ftp_upload no_proxy open_socket download_timeout ftp_command to_ipaddress to_ip6address to_hostname icons_table replace_meta replace_file_line read_file_lines flush_file_lines unflush_file_lines unix_user_input unix_group_input hlink user_chooser_button group_chooser_button foreign_check foreign_exists foreign_available foreign_require foreign_call foreign_config foreign_installed foreign_defined get_system_hostname get_webmin_version get_webmin_version_release get_webmin_full_version get_module_acl get_group_module_acl save_module_acl save_group_module_acl init_config load_language_auto load_language text_subs text encode_base64 decode_base64 encode_base32 decode_base32 get_module_info get_all_module_infos list_themes get_theme_info list_locales list_languages safe_language read_env_file write_env_file lock_file unlock_file test_lock unlock_all_files can_lock_file webmin_log additional_log var_dump webmin_debug_log system_logged backquote_logged backquote_with_timeout backquote_command kill_logged rename_logged rename_file symlink_logged symlink_file link_file make_dir make_dir_recursive set_ownership_permissions unlink_logged unlink_file copy_source_dest move_source_dest remote_session_name remote_foreign_require remote_foreign_call remote_foreign_check remote_foreign_config remote_eval remote_write remote_read remote_finished remote_error_setup remote_rpc_call remote_multi_callback remote_multi_callback_error serialise_variable unserialise_variable other_groups date_chooser_button help_file read_help_file seed_random disk_usage_kb recursive_disk_usage help_search_link make_http_connection validate_ssl_connection read_http_connection write_http_connection close_http_connection clean_environment reset_environment clean_language progress_callback switch_to_remote_user switch_to_unix_user eval_as_unix_user create_user_config_dirs create_missing_homedir filter_javascript resolve_links simplify_path same_file flush_webmin_caches list_usermods available_usermods get_available_module_infos get_visible_module_infos get_visible_modules_categories is_under_directory parse_http_url check_clicks_function load_entities_map entities_to_ascii get_product_name get_charset get_display_hostname save_module_config save_user_module_config nice_size get_perl_path get_goto_module select_all_link select_invert_link select_rows_link check_pid_file get_mod_lib module_root_directory list_mime_types guess_mime_type open_tempfile close_tempfile print_tempfile is_selinux_enabled get_clear_file_attributes reset_file_attributes cleanup_tempnames open_lock_tempfile END month_to_number number_to_month get_rbac_module_acl supports_rbac supports_ipv6 use_rbac_module_acl execute_command open_readfile open_execute_command translate_filename translate_command register_filename_callback register_command_callback capture_function_output capture_function_output_tempfile modules_chooser_button substitute_template substitute_pattern running_in_zone running_in_vserver running_in_xen running_in_openvz list_categories is_readonly_mode command_as_user list_osdn_mirrors convert_osdn_url get_current_dir supports_users supports_symlinks quote_path get_windows_root read_file_contents write_file_contents read_file_contents_limit unix_crypt split_quoted_string write_to_http_cache check_in_http_cache supports_javascript get_module_name get_module_variable clear_time_locale reset_time_locale callers_package web_libs_package get_userdb_string connect_userdb disconnect_userdb split_userdb_string uniquelc list_combined_webmin_menu list_modules_webmin_menu module_to_menu_item list_combined_system_info shell_is_bash compare_version_numbers convert_to_json convert_from_json print_json get_referer_relative get_webmin_email_url get_webmin_browser_url trim ui_link ui_help ui_img ui_link_button ui_table_start ui_table_end ui_table_row ui_table_hr ui_table_span ui_columns_start ui_columns_row ui_columns_header ui_checked_columns_row ui_radio_columns_row ui_columns_end ui_columns_table ui_form_columns_table ui_form_elements_wrapper ui_form_start ui_form_end ui_textbox ui_filebox ui_bytesbox ui_upload ui_password ui_hidden ui_select ui_multi_select ui_multi_select_javascript ui_radio ui_yesno_radio ui_checkbox ui_oneradio ui_textarea ui_user_textbox ui_users_textbox ui_group_textbox ui_groups_textbox ui_opt_textbox ui_submit ui_reset ui_button ui_date_input ui_buttons_start ui_buttons_end ui_buttons_row ui_buttons_hr ui_post_header ui_pre_footer ui_print_header ui_print_unbuffered_header ui_print_footer ui_config_link ui_print_endpage ui_subheading ui_links_row ui_hidden_javascript ui_hidden_start ui_hidden_end ui_hidden_table_row_start ui_hidden_table_row_end ui_hidden_table_start ui_hidden_table_end ui_tabs_start ui_tabs_end ui_tabs_start_tab ui_tabs_start_tabletab ui_tabs_end_tab ui_tabs_end_tabletab ui_max_text_width ui_radio_selector ui_radio_selector_javascript ui_grid_table ui_radio_table ui_up_down_arrows ui_hr ui_nav_link ui_confirmation_form ui_text_color ui_alert_box js_disable_inputs ui_page_flipper js_checkbox_disable js_redirect ui_webmin_link ui_line_break_double ui_page_refresh ui_details ui_div_row ui_paginations ui_hide_outside_of_viewport ui_read_file_contents_limit get_python_cmd get_buffer_size get_buffer_size_binary get_webprefix get_sub_ref_name setvar getvar delvar print_call_stack webmin_user_can_rpc webmin_user_login_mode webmin_user_is_admin webmin_user_is get_current_theme_info_cached miniserv_using_default_cert is_int float is_float parse_accepted_language get_default_system_locale create_wrapper); # Add global variables in web-lib.pl push(@EXPORT, qw(&unique)); diff --git a/ui-lib.pl b/ui-lib.pl index bb99fe0b7..4d068de37 100755 --- a/ui-lib.pl +++ b/ui-lib.pl @@ -683,6 +683,24 @@ return $rv; ####################### form generation functions +=head2 ui_form_elements_wrapper(formdata, formid, [class], [tags]) + +HTML5 allows to have form elements to be placed outside of an actual +form to provide support for nested forms. The requirement is to have +`id` attribute set on the form and `form` attribute to be set on each +element referencing the given form. This is the wrapper for such form +elements. + +=cut +sub ui_form_elements_wrapper +{ +return &theme_ui_form_elements_wrapper(@_) if (defined(&theme_ui_form_elements_wrapper)); +my ($formdata, $formid, $class, $tags) = @_; +return "
$formdata
" +} + =head2 ui_form_start(script, method, [target], [tags]) Returns HTML for the start of a a form that submits to some script. The @@ -2789,6 +2807,230 @@ my ($label, $content) = @_; return "
$label$content
"; } +=head2 ui_paginations(&array, &opts) + +Given array reference returns pagination buttons +and search form to be used on the page + +=cut +sub ui_paginations +{ +return &theme_ui_paginations(@_) + if (defined(&theme_ui_paginations)); + +my ($arr, $opts) = @_; +my %rv; +my $id = $main::ui_paginations++; +my @arr = @{$arr}; +my ($script_name) = $0 =~ /([^\/]*\.cgi)$/; +my $top_offset_px = int($opts->{"top_offset_px"}) || 77; +my $bottom_offset_px = int($opts->{"bottom_offset_px"}) || 77; +my $row_size_px = int($opts->{"row_size_px"}) || 26; +my $items_per_page = int($tconfig{'paginate'}) || int($opts->{"paginate${id}"}) || 20; +my $curent_page = int($opts->{"page${id}"}) || 1; +my $search_term = &un_urlize($opts->{"search${id}"}); +my $search_placeholder = $opts->{'search_placeholder'} || $text{'ui_searchok'}; +my $pagination_target = $opts->{'pagination_target'} || $script_name; +my $pagination_action = $opts->{'pagination_action'} || "post"; +my $search_target = $opts->{'search_target'} || $script_name; +my $search_action = $opts->{'search_action'} || "post"; +my $paginator_wrap_class = $opts->{'paginator_wrap_class'} || "ui_form_elements_wrapper_paginator"; +my $search_wrap_class = $opts->{'search_wrap_class'} || "ui_form_elements_wrapper_search"; +my $link_page_cls = $opts->{'paginator_link_class'} || 'ui_link_pagination'; +my $link_search_cls = $opts->{'paginator_textbox_class'} || 'ui_textbox_pagination'; +my $text_showing_cls = $opts->{'paginator_text_showing'} || 'ui_showing_items'; +my $exported_form = $opts->{'_form-exports'}; +my $ui_column_colspan = int($exported_form->{'colspan'} || 2); + +# If we have a search string filter existing content +if (ref($arr) eq 'ARRAY' && $arr->[0]) { + if ($search_term) { + my @sarr; + map { + if (ref($_) eq 'ARRAY') { + arr: for (my $i = 0; $i <= $#$_; $i++) { + push(@sarr, $_), last arr + if(index(lc($_->[$i]), lc($search_term)) != -1); + } + } + if (ref($_) eq 'HASH') { + hash: foreach my $__ (values %{$_}) { + push(@sarr, $_), last hash + if(index(lc($__), lc($search_term)) != -1); + } + } + } @arr; + @arr = @sarr; + } + + # Can pagination be done automatically + # depending on the client screen height? + my $items_per_page_client = int($opts->{'client_height'} || get_http_cookie('client_height')); + my $items_per_page = + $tconfig{'paginate-noauto'} ? + $items_per_page : + (int($ENV{'HTTP_X_CLIENT_PAGINATE'}) || + ($items_per_page_client ? + ((int(($items_per_page_client - + $top_offset_px - $bottom_offset_px) / $row_size_px))) : $items_per_page)); + # If caller wants specific pagination number, + # e.g. a module config, use that instead + if ($exported_form && $exported_form->{'paginate'}) { + $items_per_page = $exported_form->{'paginate'}; + } + + # Pagination + my $totals_items_original = scalar(@arr); + my $total_pages = ceil(($totals_items_original) / $items_per_page); + my $total_pages_length = length($total_pages); + + # Return pagination jumper only + # if there is more than one page + if ($total_pages > 1) { + my $totals_items_spliced = $totals_items_original; + my $start_page_with = $curent_page * $items_per_page; + $curent_page = $total_pages + if ($curent_page > $total_pages); + $curent_page = 1 + if ($curent_page <= 0); + + my $curent_page_prev = $curent_page - 1; + my $page_prev_disabled = $curent_page_prev <= 0 ? " disabled" : ""; + my $curent_page_next = $curent_page + 1; + my $page_next_disabled = $curent_page_next > $total_pages ? " disabled" : ""; + my $splice_start = $items_per_page * $curent_page_prev; + my $splice_end = $items_per_page; + @arr = splice(@arr, $splice_start, $splice_end); + $totals_items_spliced = scalar(@arr); + + # + # Pagination jumper + # + my $paginator_id = 'paginator-form'; + my $paginator_data = "$paginator_id-data"; + + # Paginator form + $rv{$paginator_id} = + &ui_form_start($pagination_target, "e_escape($pagination_action), undef, "id='$paginator_id${id}'"); + $rv{$paginator_id} .= &ui_form_end(); + + # Paginator form data + $rv{$paginator_data} = &ui_hidden("search${id}", $search_term, "$paginator_id${id}") + if ($search_term); + $rv{$paginator_data} .= &ui_hidden("paginate${id}", $items_per_page, "$paginator_id${id}"); + + # Calculate showing start and range numbers + my $current_showing_start = + $curent_page == 1 ? 1 : int(($items_per_page * $curent_page + 1) - $items_per_page); + my $current_showing_range = + int($current_showing_start + $items_per_page > $totals_items_original ? + $totals_items_original : $current_showing_start + $items_per_page - 1); + + # Showing items range selector text + $rv{$paginator_data} .= + "@{[ + &text('paginator_showing_start', $current_showing_start, + $current_showing_range, $totals_items_original) ]} "; + + # Dynamically add external form elements to arrow links + my $exported_form_query = ""; + if ($exported_form) { + foreach (keys %{$exported_form}) { + $exported_form_query .= "&"."$_=@{[&urlize($exported_form->{$_})]}"; + } + } + # + # Arrow links + # + my $search_term_urlize = &urlize($search_term); + my $curent_page_prev_urlize = &urlize($curent_page_prev); + my $curent_page_next_urlize = &urlize($curent_page_next); + my $items_per_page_urlize = &urlize($items_per_page); + my $total_pages_html_escape = &html_escape($total_pages); + + # Arrow link left + $rv{$paginator_data} .= + &ui_link("$pagination_target?page${id}=$curent_page_prev_urlize". + "&search${id}=$search_term_urlize&paginate${id}=$items_per_page_urlize$exported_form_query", + ' ⏴ ', + "@{[&html_escape($link_page_cls)]} @{[&html_escape($link_page_cls)]}_left$page_prev_disabled"); + + # Page number input selector + $rv{$paginator_data} .= + &ui_textbox("page${id}", $curent_page, $total_pages_length, undef, $total_pages_length, + "data-class='@{["e_escape($link_search_cls)]}' form='$paginator_id${id}'"); + + # Out of pages text + $rv{$paginator_data} .= + " @{[&text('paginator_showing_end', + $total_pages_html_escape)]}"; + + # Arrow link right + $rv{$paginator_data} .= + &ui_link("$pagination_target?page${id}=$curent_page_next_urlize". + "&search${id}=$search_term_urlize&paginate${id}=$items_per_page_urlize$exported_form_query", + ' ▸ ', + "@{[&html_escape($link_page_cls)]} @{[&html_escape($link_page_cls)]}_right$page_next_disabled"); + + # Dynamically adding external form elements + if ($exported_form) { + foreach (keys %{$exported_form}) { + $rv{$paginator_data} .= &ui_hidden($_, $exported_form->{$_}, "$paginator_id${id}"); + } + } + $rv{$paginator_data} = + &ui_form_elements_wrapper($rv{$paginator_data}, "$paginator_id${id}", + "e_escape($paginator_wrap_class)) + } + # + # Search form + # + if ($total_pages > 1 || $search_term) { + my $search_id = 'search-form'; + my $search_data = "$search_id-data"; + + # Paginator search form + $rv{$search_id} = &ui_form_start($search_target, + "e_escape($search_action), undef, "id='$search_id${id}'"); + $rv{$search_id} .= &ui_form_end(); + + # Paginator search form data + $rv{$search_data} .= &ui_hidden("paginate${id}", $items_per_page, "$search_id${id}"); + $rv{$search_data} .= &ui_hidden("page${id}", 1, "$search_id${id}"); + my $search_placeholder_length = length($search_term) || length($search_placeholder); + $search_placeholder_length = $search_placeholder_length < 8 ? 8 : $search_placeholder_length; + $search_placeholder_length = 24 if ($search_placeholder_length >= 24); + + # Search box + $rv{$search_data} .= + &ui_textbox("search${id}", $search_term, $search_placeholder_length, undef, undef, + "data-class='@{["e_escape($link_search_cls)]}_search' ". + "placeholder='@{["e_escape($search_placeholder)]}' form='$search_id${id}'"); + + # Search reset using JS + $rv{$search_data} .= + &ui_reset('⛌', undef, + "onclick='document.getElementById(\"$search_id${id}\").search${id}.value = \"\";". + "document.getElementById(\"$search_id${id}\").submit()'"); + + # Dynamically adding external form elements + if ($exported_form) { + foreach (keys %{$exported_form}) { + $rv{$search_data} .= &ui_hidden($_, $exported_form->{$_}, "$search_id${id}"); + } + } + $rv{$search_data} = &ui_form_elements_wrapper($rv{$search_data}, "$search_id${id}", "e_escape($search_wrap_class)); + + # Search no results + $rv{"search-no-results"} = + &ui_columns_row([&text('paginator_nosearchrs', &html_escape($search_term))], + ['colspan="'.$ui_column_colspan.'" align="center"']); + } + } +@$arr = @arr; +return \%rv; +} + =head2 ui_hide_outside_of_viewport(elem) Prints element if not in viewport. Useful