ABAP File Operations : Desktop and Server

Sometimes, we need to get a file from the presentation server or the application server. Usually, we need to fork the code in order to be able to use one or the other. Here, I'll show a simple class to make this task a lot easier. All the usual file/directory operations, are called the same way. The only distinction is a flag to indicate that the file should be considered in the desktop or in the server.
The class only has static methods, to use it, you just need to call any of the public methods.
This is the beggining, in the future I'll try to allow FTP, network shares, among others and consider to create a instanciable class to deal with connection, autentication, etc.

1 - Create the following Class

2 - Create the following Methods:

3 - Use the following parameters for each method:

4 - Insert the appropriate code in each method:

method COPY_FILE. data: l_file_from type string, l_path_from type string, l_file_to type string, l_path_to type string. l_file_from = i_file_from. l_path_from = i_path_from. if i_file_to is initial. l_file_to = i_file_from. endif. if i_path_to is initial. l_path_to = i_path_from. endif. if not l_file_from = l_file_to and not l_path_from = l_path_to. if i_desktop = 'X'. copy_file_desktop( exporting i_file_from = l_file_from i_file_to = l_file_to i_path_from = l_path_from i_path_to = l_path_to exceptions error = 1 others = 2 ). else. copy_file_server( exporting i_file_from = l_file_from i_file_to = l_file_to i_path_from = l_path_from i_path_to = l_path_to exceptions error = 1 others = 2 ). endif. endif. if not sy-subrc is initial. raise ERROR. endif. endmethod. method COPY_FILE_DESKTOP. data: l_file_from type string, l_file_to type string. free: l_file_from, l_file_to. concatenate i_path_from i_file_from into l_file_from. concatenate i_path_to i_file_to into l_file_to. cl_gui_frontend_services=>file_copy( exporting source = l_file_from destination = l_file_to overwrite = 'X' exceptions cntl_error = 1 error_no_gui = 2 wrong_parameter = 3 disk_full = 4 access_denied = 5 file_not_found = 6 destination_exists = 7 unknown_error = 8 path_not_found = 9 disk_write_protect = 10 drive_not_ready = 11 not_supported_by_gui = 12 others = 13 ). if not sy-subrc is initial. raise error. endif. clear: l_file_from, l_file_to. free: l_file_from, l_file_to. endmethod. method COPY_FILE_SERVER. data: l_file_from type string, l_file_to type string, l_file_line type dxrawdata, l_line_length type i. clear: l_file_from, l_file_to, l_file_line, l_line_length. concatenate i_path_from i_file_from into l_file_from. concatenate i_path_to i_file_to into l_file_to. open dataset l_file_from for input in binary mode. if sy-subrc is initial. open dataset l_file_to for output in binary mode. if sy-subrc is initial. read dataset l_file_from into l_file_line actual length l_line_length. if sy-subrc is initial. transfer l_file_line to l_file_to length l_line_length. else. close dataset l_file_from. close dataset l_file_to. endif. else. close dataset l_file_from. raise error. endif. else. raise error. endif. clear: l_file_from, l_file_to, l_file_line, l_line_length. free: l_file_from, l_file_to, l_file_line, l_line_length. endmethod. method DELETE_FILE. if i_desktop = 'X'. delete_file_desktop( exporting i_file = i_file i_path = i_path exceptions error = 1 others = 2 ). else. delete_file_server( exporting i_file = i_file i_path = i_path exceptions error = 1 others = 2 ). endif. if not sy-subrc is initial. raise ERROR. endif. endmethod. method DELETE_FILE_DESKTOP. data: l_file type string, l_rc type i. clear: l_file, l_rc. concatenate i_file i_path into l_file. cl_gui_frontend_services=>file_delete( exporting filename = l_file changing rc = l_rc exceptions file_delete_failed = 1 cntl_error = 2 error_no_gui = 3 file_not_found = 4 access_denied = 5 unknown_error = 6 not_supported_by_gui = 7 wrong_parameter = 8 others = 9 ). if not sy-subrc is initial. raise error. endif. clear: l_file, l_rc. free: l_file, l_rc. endmethod. method DELETE_FILE_SERVER. data: l_file type string. clear: l_file. concatenate i_path i_file into l_file. call function 'ISH_N2_DELETE_FILE_APP_SERVER' exporting ss_file = l_file exceptions error = 1 others = 2. if not sy-subrc is initial. raise ERROR. endif. clear: l_file. free: l_file. endmethod. method DOWNLOAD. if i_desktop = 'X'. download_desktop( exporting i_file = i_file i_path = i_path importing et_table = et_table exceptions error = 1 others = 2 ). else. download_server( exporting i_file = i_file i_path = i_path importing et_table = et_table exceptions error = 1 others = 2 ). endif. if not sy-subrc is initial. raise ERROR. endif. endmethod. method DOWNLOAD_DESKTOP. data: l_file type string, l_type(10). clear: l_file, l_type. cl_gui_frontend_services=>gui_download( exporting filename = l_file filetype = l_type changing data_tab = et_table exceptions file_write_error = 1 no_batch = 2 gui_refuse_filetransfer = 3 invalid_type = 4 no_authority = 5 unknown_error = 6 header_not_allowed = 7 separator_not_allowed = 8 filesize_not_allowed = 9 header_too_long = 10 dp_error_create = 11 dp_error_send = 12 dp_error_write = 13 unknown_dp_error = 14 access_denied = 15 dp_out_of_memory = 16 disk_full = 17 dp_timeout = 18 file_not_found = 19 dataprovider_exception = 20 control_flush_error = 21 not_supported_by_gui = 22 error_no_gui = 23 others = 24 ). if not sy-subrc is initial. raise ERROR. endif. clear: l_file, l_type. free: l_file, l_type. endmethod. method DOWNLOAD_SERVER. data: l_file type string. field-symbols: <lt_table> type standard table, <l_table_line> type any. clear: l_file. assign et_table to <lt_table>. concatenate i_path i_file into l_file. if i_type = 'BIN'. open dataset l_file for output in binary mode. else. open dataset l_file for output in text mode encoding default. endif. if sy-subrc is initial. loop at <lt_table> assigning <l_table_line>. transfer <l_table_line> to l_file. if not sy-subrc is initial. close dataset l_file. exit. endif. endloop. else. raise ERROR. endif. clear: l_file. free: l_file. endmethod. method MOVE_FILE. if i_desktop = 'X'. move_file_desktop( exporting i_file = i_file i_path_from = i_path_from i_path_to = i_path_to exceptions error = 1 others = 2 ). else. move_file_server( exporting i_file = i_file i_path_from = i_path_from i_path_to = i_path_to exceptions error = 1 others = 2 ). endif. if not sy-subrc is initial. raise ERROR. endif. endmethod. method MOVE_FILE_DESKTOP. copy_file_desktop( exporting i_file_from = i_file i_path_from = i_path_from i_file_to = i_file i_path_to = i_path_to exceptions error = 1 others = 2 ). if sy-subrc is initial. delete_file_desktop( exporting i_file = i_file i_path = i_path_from exceptions error = 1 others = 2 ). if not sy-subrc is initial. raise ERROR. endif. else. raise ERROR. endif. endmethod. method MOVE_FILE_SERVER. copy_file_server( exporting i_file_from = i_file i_path_from = i_path_from i_file_to = i_file i_path_to = i_path_to exceptions error = 1 others = 2 ). if sy-subrc is initial. delete_file_server( exporting i_file = i_file i_path = i_path_from exceptions error = 1 others = 2 ). if not sy-subrc is initial. raise ERROR. endif. else. raise ERROR. endif. endmethod. method SELECT_FILE. if i_desktop = 'X'. select_file_desktop( exporting i_mask = i_mask changing ch_file = ch_file ch_path = ch_path exceptions error = 1 others = 2 ). else. select_file_server( exporting i_mask = i_mask changing ch_file = ch_file ch_path = ch_path exceptions error = 1 others = 2 ). endif. if not sy-subrc is initial. raise ERROR. endif. endmethod. method SELECT_FILE_DESKTOP. data: lt_file_table type filetable, l_file_table_line like line of lt_file_table, l_file type string, l_rc type i. cl_gui_frontend_services=>file_open_dialog( exporting window_title = '' default_filename = ch_file initial_directory = ch_path multiselection = ' ' changing file_table = lt_file_table rc = l_rc exceptions file_open_dialog_failed = 1 cntl_error = 2 error_no_gui = 3 not_supported_by_gui = 4 others = 5 ). if sy-subrc is initial. read table lt_file_table index 1 into l_file_table_line. if sy-subrc is initial. l_file = l_file_table_line. split_path_desktop( exporting i_file = l_file importing e_file = ch_file e_path = ch_path exceptions error = 1 others = 2 ). if not sy-subrc is initial. raise ERROR. endif. else. raise ERROR. endif. else. raise ERROR. endif. endmethod. method SELECT_FILE_SERVER. data: l_file type string. clear: l_file. call function '/SAPDMC/LSM_F4_SERVER_FILE' exporting directory = ch_path * filemask = ' ' importing serverfile = l_file exceptions canceled_by_user = 1 others = 2. if sy-subrc is initial. split_path_server( exporting i_file = l_file importing e_file = ch_file e_path = ch_path exceptions error = 1 others = 2 ). if not sy-subrc is initial. raise ERROR. endif. else. raise ERROR. endif. clear: l_file. free: l_file. endmethod. method SELECT_PATH. if i_desktop = 'X'. select_path_desktop( changing ch_path = ch_path exceptions error = 1 others = 2 ). else. select_path_server( changing ch_path = ch_path exceptions error = 1 others = 2 ). endif. if not sy-subrc is initial. raise ERROR. endif. endmethod. method SELECT_PATH_DESKTOP. cl_gui_frontend_services=>directory_browse( exporting window_title = '' initial_folder = ch_path changing selected_folder = ch_path exceptions cntl_error = 1 error_no_gui = 2 not_supported_by_gui = 3 others = 4 ). if not sy-subrc is initial. raise ERROR. endif. endmethod. method SELECT_PATH_SERVER. data: l_file type string. clear: l_file. select_file_server( changing ch_file = l_file ch_path = ch_path exceptions error = 1 others = 2 ). if not sy-subrc is initial. raise ERROR. endif. clear: l_file. free: l_file. endmethod. method SPLIT_PATH. if i_desktop = 'X'. split_path_desktop( exporting i_file = i_file importing e_file = e_file e_path = e_path exceptions error = 1 others = 2 ). else. split_path_server( exporting i_file = i_file importing e_file = e_file e_path = e_path exceptions error = 1 others = 2 ). endif. if not sy-subrc is initial. raise ERROR. endif. endmethod. method SPLIT_PATH_DESKTOP. data: lt_path type table of string, l_path like line of lt_path, l_lines type i, l_separator. clear: l_lines, l_separator, l_path, lt_path, lt_path[]. cl_gui_frontend_services=>get_file_separator( changing file_separator = l_separator exceptions cntl_error = 1 error_no_gui = 2 not_supported_by_gui = 3 others = 4 ). if sy-subrc is initial. split i_file at l_separator into table lt_path. describe table lt_path lines l_lines. read table lt_path into l_path index l_lines. if sy-subrc is initial. e_file = l_path. delete lt_path index l_lines. loop at lt_path into l_path. if sy-tabix = 1. concatenate l_path l_separator into e_path. else. concatenate e_path l_path l_separator into e_path. endif. endloop. else. raise ERROR. endif. else. raise ERROR. endif. clear: l_lines, l_separator, l_path, lt_path, lt_path[]. free: l_lines, l_separator, l_path, lt_path, lt_path[]. endmethod. method SPLIT_PATH_SERVER. data: lt_path type table of string, l_path like line of lt_path, l_lines type i, l_separator. clear: l_lines, l_separator, l_path, lt_path, lt_path[]. call function 'WSAF_BUILD_SEPARATOR' importing separator = l_separator exceptions separator_not_maintained = 1 wrong_call = 2 wsaf_config_not_maintained = 3 others = 4. if sy-subrc is initial. split i_file at l_separator into table lt_path. describe table lt_path lines l_lines. read table lt_path into l_path index l_lines. if sy-subrc is initial. e_file = l_path. delete lt_path index l_lines. loop at lt_path into l_path. if sy-tabix = 1. concatenate l_path l_separator into e_path. else. concatenate e_path l_path l_separator into e_path. endif. endloop. else. raise ERROR. endif. else. raise ERROR. endif. clear: l_lines, l_separator, l_path, lt_path, lt_path[]. free: l_lines, l_separator, l_path, lt_path, lt_path[]. endmethod. method UPLOAD. if i_desktop = 'X'. upload_desktop( exporting i_type = i_type i_path = i_path i_file = i_file importing et_table = et_table exceptions error = 1 others = 2 ). else. upload_server( exporting i_type = i_type i_path = i_path i_file = i_file importing et_table = et_table exceptions error = 1 others = 2 ). endif. if not sy-subrc is initial. raise ERROR. endif. endmethod. method UPLOAD_DESKTOP. data: l_file type string, l_type(10). clear: l_file, l_type. concatenate i_path i_file into l_file. case i_type. when 'ASC'. l_type = 'ASC'. when 'BIN'. l_type = 'BIN'. endcase. cl_gui_frontend_services=>gui_upload( exporting filename = l_file filetype = l_type changing data_tab = et_table exceptions file_open_error = 1 file_read_error = 2 no_batch = 3 gui_refuse_filetransfer = 4 invalid_type = 5 no_authority = 6 unknown_error = 7 bad_data_format = 8 header_not_allowed = 9 separator_not_allowed = 10 header_too_long = 11 unknown_dp_error = 12 access_denied = 13 dp_out_of_memory = 14 disk_full = 15 dp_timeout = 16 not_supported_by_gui = 17 error_no_gui = 18 others = 19 ). if not sy-subrc is initial. raise ERROR. endif. clear: l_file, l_type. free: l_file, l_type. endmethod. method UPLOAD_SERVER. data: l_file type string, l_file_line type dxrawdata, l_table_line type ref to data. field-symbols: <lt_table> type standard table, <l_table_line> type any. clear: l_file, l_file_line, l_table_line. assign et_table to <lt_table>. create data l_table_line like line of <lt_table>. assign l_table_line to <l_table_line>. concatenate i_path i_file into l_file. if i_type = 'BIN'. open dataset l_file for input in binary mode. else. open dataset l_file for input in text mode encoding default. endif. if sy-subrc is initial. read dataset l_file into l_file_line. if sy-subrc is initial. <l_table_line> = l_file_line. append <l_table_line> to <lt_table>. else. close dataset l_file. endif. else. raise ERROR. endif. clear: l_file, l_file_line, l_table_line. free: l_file, l_file_line, l_table_line. endmethod.