swad-core/swad_browser_resource.c

// swad_browser_resource.c: links to documents as program resources
/*
    SWAD (Shared Workspace At a Distance),
    is a web platform developed at the University of Granada (Spain),
    and used to support university teaching.

    This file is part of SWAD core.
    Copyright (C) 1999-2023 Antonio Cañas Vargas

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as
    published by the Free Software Foundation, either version 3 of the
    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
/*****************************************************************************/
/********************************* Headers ***********************************/
/*****************************************************************************/

#include "swad_action.h"
#include "swad_action_list.h"
#include "swad_alert.h"
#include "swad_browser.h"
#include "swad_browser_resource.h"
#include "swad_error.h"
#include "swad_form.h"
#include "swad_global.h"
#include "swad_parameter_code.h"
#include "swad_program.h"
#include "swad_program_database.h"
#include "swad_program_resource.h"

/*****************************************************************************/
/******************** Global variables from other modules ********************/
/*****************************************************************************/

extern struct Globals Gbl;

/*****************************************************************************/
/****************************** Get link to file *****************************/
/*****************************************************************************/

void BrwRsc_GetLinkToFile (void)
  {
   extern const char *Txt_Link_to_resource_X_copied_into_clipboard;
   long FilCod;
   char Title[NAME_MAX + 1];	// File or link name
   Rsc_Type_t Type;

   /***** Get parameters related to file browser *****/
   Brw_GetParAndInitFileBrowser ();

   /***** Get file code *****/
   FilCod = ParCod_GetAndCheckPar (ParCod_Fil);

   /***** Get file title *****/
   switch (Gbl.Action.Act)
     {
      case ActReqLnkSeeDocCrs:
      case ActReqLnkAdmDocCrs:
	 Type = Rsc_DOCUMENT;
         BrwRsc_GetTitleFromDocFilCod (FilCod,Title,sizeof (Title) - 1);
	 break;
      case ActReqLnkSeeMrkCrs:
      case ActReqLnkAdmMrkCrs:
	 Type = Rsc_MARKS;
         BrwRsc_GetTitleFromMrkFilCod (FilCod,Title,sizeof (Title) - 1);
	 break;
      default:
	 Type = Rsc_NONE;	// Initialized to avoid warning
	 Err_WrongTypeExit ();
	 break;
     }

   /***** Copy link to file into resource clipboard *****/
   Prg_DB_CopyToClipboard (Type,FilCod);

   /***** Write sucess message *****/
   Ale_ShowAlert (Ale_SUCCESS,Txt_Link_to_resource_X_copied_into_clipboard,
		  Title);

   /***** Show again the file browser *****/
   Brw_ShowAgainFileBrowserOrWorks ();
  }

/*****************************************************************************/
/************************ Write document as resource *************************/
/*****************************************************************************/

void BrwRsc_WriteResourceDocument (long FilCod,bool PutFormToGo,
                                   const char *Icon,const char *IconTitle)
  {
   extern const char *Txt_Documents;
   extern const char *Txt_Actions[ActLst_NUM_ACTIONS];
   Act_Action_t NextAction = ActUnk;	// Initialized to avoid warning
   struct Brw_FileMetadata FileMetadata;
   char Title[NAME_MAX + 1];	// File or link name

   /***** Get file metadata *****/
   FileMetadata.FilCod = FilCod;
   if (FileMetadata.FilCod > 0)
      Brw_GetFileMetadataByCod (&FileMetadata);
      // If file doesn't exist ==> file code is changed to -1

   /***** Set title *****/
   if (FileMetadata.FilCod > 0)
      /***** Copy file name into title *****/
      Str_Copy (Title,FileMetadata.FilFolLnk.Name,sizeof (Title) - 1);
   else
      /***** Generic title for all documents *****/
      Str_Copy (Title,Txt_Documents,sizeof (Title) - 1);

   /***** Begin form to go to file data *****/
   if (PutFormToGo)
     {
      NextAction = (FileMetadata.FilCod > 0) ? ActReqDatSeeDocCrs :	// Document specified
					       ActSeeAdmDocCrsGrp;	// All documents
      Frm_BeginForm (NextAction);
         if (FileMetadata.FilCod > 0)
	    Brw_PutParsFileBrowser (NULL,		// Not used
				    NULL,		// Not used
				    Brw_IS_UNKNOWN,	// Not used
				    FileMetadata.FilCod);
	 HTM_BUTTON_Submit_Begin (Txt_Actions[NextAction],
	                          "class=\"LM BT_LINK PRG_LNK_%s\"",
	                          The_GetSuffix ());
     }

   /***** Icon depending on type ******/
   if (FileMetadata.FilCod > 0)
      switch (FileMetadata.FilFolLnk.Type)
	{
	 case Brw_IS_FILE:
	    Brw_PutIconFile (FileMetadata.FilFolLnk.Name,
			     "CONTEXT_OPT ICO_HIGHLIGHT CONTEXT_ICO16x16",
			     PutFormToGo);	// Put link to view metadata
	    break;
	 case Brw_IS_LINK:
	    if (PutFormToGo)
	       Ico_PutIconLink ("up-right-from-square.svg",Ico_BLACK,NextAction);
	    else
	       Ico_PutIconOn ("up-right-from-square.svg",Ico_BLACK,IconTitle);
	    break;
	 default:
	    break;
	}
   else	// Documents zone
     {
      if (PutFormToGo)
	 Ico_PutIconLink (Icon,Ico_BLACK,NextAction);
      else
	 Ico_PutIconOn (Icon,Ico_BLACK,IconTitle);
     }

   /***** Write title *****/
   HTM_Txt (Title);

   /***** End form to download file *****/
   if (PutFormToGo)
     {
         HTM_BUTTON_End ();
      Frm_EndForm ();
     }
  }

/*****************************************************************************/
/************************ Write marks file as resource ***********************/
/*****************************************************************************/

void BrwRsc_WriteResourceMarksFile (long FilCod,bool PutFormToGo,
                                    const char *Icon,const char *IconTitle)
  {
   extern const char *Txt_Marks_area;
   extern const char *Txt_Actions[ActLst_NUM_ACTIONS];
   Act_Action_t NextAction;
   struct Brw_FileMetadata FileMetadata;
   char Title[NAME_MAX + 1];	// File or link name

   /***** Get file metadata *****/
   FileMetadata.FilCod = FilCod;
   if (FileMetadata.FilCod > 0)
      Brw_GetFileMetadataByCod (&FileMetadata);
      // If file doesn't exist ==> file code is changed to -1

   /***** Set title *****/
   if (FileMetadata.FilCod > 0)
      /***** Copy file name into title *****/
      Str_Copy (Title,FileMetadata.FilFolLnk.Name,sizeof (Title) - 1);
   else
      /***** Generic title for all documents *****/
      Str_Copy (Title,Txt_Marks_area,sizeof (Title) - 1);

   /***** Begin form to go to file data *****/
   if (PutFormToGo)
     {
      NextAction = (FileMetadata.FilCod > 0) ? ActReqDatSeeMrkCrs :	// Marks file specified
					       ActSeeAdmMrk;		// All marks files
      Frm_BeginForm (NextAction);
         if (FileMetadata.FilCod > 0)
	    Brw_PutParsFileBrowser (NULL,		// Not used
				    NULL,		// Not used
				    Brw_IS_UNKNOWN,	// Not used
				    FileMetadata.FilCod);
	 HTM_BUTTON_Submit_Begin (Txt_Actions[NextAction],
	                          "class=\"LM BT_LINK PRG_LNK_%s\"",
	                          The_GetSuffix ());
     }

   /***** Icon depending on type ******/
   if (PutFormToGo)
      Ico_PutIconLink (Icon,Ico_BLACK,NextAction);
   else
      Ico_PutIconOn (Icon,Ico_BLACK,IconTitle);

   /***** Write filename *****/
   HTM_Txt (Title);

   /***** End form to download file *****/
   if (PutFormToGo)
     {
         HTM_BUTTON_End ();
      Frm_EndForm ();
     }
  }

/*****************************************************************************/
/******************** Get document name from file code ***********************/
/*****************************************************************************/
// The trailing null character is not counted in TitleSize

void BrwRsc_GetTitleFromDocFilCod (long FilCod,char *Title,size_t TitleSize)
  {
   extern const char *Txt_Documents;
   struct Brw_FileMetadata FileMetadata;

   if (FilCod > 0)
     {
      /***** Get file name *****/
      FileMetadata.FilCod = FilCod;
      Brw_GetFileNameByCod (&FileMetadata);

      /***** Copy file name into title *****/
      Str_Copy (Title,FileMetadata.FilFolLnk.Name,TitleSize);
     }
   else
      /***** Generic title for all documents *****/
      Str_Copy (Title,Txt_Documents,TitleSize);
  }

/*****************************************************************************/
/******************* Get marks file name from file code **********************/
/*****************************************************************************/
// The trailing null character is not counted in TitleSize

void BrwRsc_GetTitleFromMrkFilCod (long FilCod,char *Title,size_t TitleSize)
  {
   extern const char *Txt_Marks_area;
   struct Brw_FileMetadata FileMetadata;

   if (FilCod > 0)
     {
      /***** Get file name *****/
      FileMetadata.FilCod = FilCod;
      Brw_GetFileNameByCod (&FileMetadata);

      /***** Copy file name into title *****/
      Str_Copy (Title,FileMetadata.FilFolLnk.Name,TitleSize);
     }
   else
      /***** Generic title for marks area *****/
      Str_Copy (Title,Txt_Marks_area,TitleSize);
  }