CpyF2Web

Informações importantes

🚨 Função disponível a partir da versão 9.1.x do SmartClient HTML (webapp)

A função copia um arquivo do ambiente do servidor (a partir do rootpath) ou do cliente (WebAgent), para o SmartClient HTML.
Se o arquivo for copiado para a pasta temporária ( user ) no Servidor Web, esta pasta é deletada automaticamente quando a sessão é finalizada.
Já se o arquivo for copiado para a pasta de persistência (Cache) do servidor Web, a pasta será mantida no servidor Web até que seja excluída manualmente pelo administrador do ambiente.

Sintaxe

CpyF2Web( < cOrigem >, [ lIsUserDiskDir ], [ lCompactCopy ], [ lChangeCase ], [ lUnZipFile ] )

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cOrigem	caractere	Indica o arquivo a ser usado como origem da cópia.	X
lIsUserDiskDir	lógico	Indica se o arquivo vai ser salvo na pasta temporária ou na pasta do Environment onde está o Servidor Web. Default = .T. (verdadeiro).
lCompactCopy	lógico	Indica se o arquivo deve ser internamente compactado antes de fazer a cópia. Default = .T. (verdadeiro).
lChangeCase	lógico	Se verdadeiro (.T.), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso (.F.), não será feito nenhum ajuste no nome do arquivo informado. Default = .T. (verdadeiro). Veja maiores informações em Observações.
lUnZipFile	lógico	Se verdadeiro (.T.), o arquivo será descompactado. caso contrário, falso (.F.), não faz nada. Default = .F. (falso).

Retorno

Nome	Tipo	Descrição
nRet	caractere	Retorna o caminho do servidor web onde o arquivo foi salvo com sucesso. Caso ocorra alguma falha na cópia, retorna um valor vazio.

Observações

Esta função está disponível somente para o SmartClient HTML.
A função CpyF2Web exige que o programa AdvPL que a execute seja um SmartClient, não permitindo, portanto, que seja chamada em JOB. A partir da build 7.00.210324P, caso a função seja chamada em JOB, o programa será finalizado com ocorrência de erro fatal "Function CpyF2Web() doesn't available in JOB.".
Em caso de falha, pode ser utilizada a função FError, porém não é possível saber se a falha na cópia está relacionada com algum problema de acesso na origem, no destino, ou mesmo durante a cópia. Normalmente as causas mais prováveis de falha são inconsistências nos parâmetros, como especificar um arquivo de origem que não existe, ou que esteja em uso por outro processo; ou especificar um diretório de destino que não exista; ou que o usuário que iniciou o programa não tenha direitos de escrita; falta de espaço em disco no destino durante a cópia; falha no acesso ao sistema de arquivos na pasta temporária do servidor Web ou do SmartClient; ou ainda o arquivo já exista no diretório de destino, e esteja em uso por outro processo.
Caso a compactação esteja habilitada (Default = .T.), no parâmetro <lCompactCopy>, o arquivo será compactado automaticamente no client antes do envio, e descompactado automaticamente no servidor Web. Para a grande parte dos tipos de arquivo, utilizar a compactação reduz o tempo de cópia, pois o conteúdo trafegado pela rede é menor. Para tráfego de arquivos que já possuem algum tipo de compressão de dados (ZIP, TAR, RAR, JPG, MPG), é mais eficiente especificar este parâmetro com .F., para que a compactação automática não seja utilizada, pois nestes casos a mesma não agregará nenhum ganho neste processo. O arquivo compactado é gravado na pasta temporária do client e descompactado na pasta de destino do servidor Web.
O parâmetro opcional lChangeCase foi introduzido pois em sistemas LINUX/UNIX, existe a diferenciação entre maiúsculo e minúsculo em nomes de arquivos ou pastas. Quando este parâmetro for informado, terá prioridade sobre comportamento de Case Sensitive definido pelas chaves de ini CASESENSITIVE ou SERVERTYPE. Porem, quando não especificado o parâmetro, o valor padrão (.T.) fica condicionado ao que está configurado nessas chaves.
Em ambiente Windows, os nomes de arquivos e pastas não possuem diferenciação entre maiúsculo e minúsculo, logo, a função conseguirá tratar os arquivos e pastas independente do valor definido no parâmetro lChangeCase.
Quando o SmartClient utilizado for uma build nativa Linux ou Mac, sabe-se que sistema de arquivos destas plataformas não têm unidade de disco, a nomenclatura dos arquivos é case sensitive (letras minúsculas diferente de maiúsculas), e as barras separadoras de diretório / pasta são barras normais "/" ao invés de barras inversas "\". Mesmo nestes casos, deve-se especificar uma letra de unidade de disco no diretório de destino; pois quando o SmartClient em Linux e/ou Mac receber o diretório de destino, com a unidade de disco especificada, a unidade de disco será ignorada e as barras serão internamente invertidas. Por exemplo, a cópia especificando o path de destino "C:\USER\LOCAL\TEMP\" será interpretado pelo SmartClient Linux e/ou Mac como "/user/local/temp/".
Quando a origem for do lado do cliente é obrigatório a utilização do WebAgent.

Exemplos

#include "TOTVS.CH"

User Function drivetoweb()
	// Copia arquivo do remote local para o servidor Web, sem compactação antes de transmitir
	Local nRet := CpyF2Web("c:/arquivos/origem.zip", .T., .F., .T., .F.)
	If (nRet != "")
		conout(nRet) // f85852b1-ab7d-44df-9c19-f146e476fa16/user/4833a3e64891454fb5549359273c3727/origem.zip
	Else
		conout("Falha na copia")
	EndIf
Return

User Function servetoweb()
	// Copia arquivo do servidor para o Servidor Web, compactando antes de transmitir
	Local nRet := CpyF2Web("/images/imagem.png", .F., .T., .F., .F.)
	If (nRet != "")
		conout(nRet) // 4d8a25c6-474e-4f40-bc2d-8c3b76b51e55/cache/environment/imagem.png
	Else
		conout("Falha na copia")
	EndIf
Return

User Function unixtoweb()
	// Utilizando Linux como exemplo para copia do arquivo do remote local para o servidor Web
	Local nRet := CpyF2Web("l:/home/user/teste.png", .T., .T., .T., .T.)
	If (nRet != "")
		conout(nRet)
	Else
		conout("Falha na copia" + nRet)
	EndIf
Return

Árvore de páginas

Sintaxe

Parâmetros

Retorno

Exemplos

Veja também