Flag for just create an empty file if not exists? - php

Which flag should i use for create a file if not exists? Please not that i'll close the point right after fopen() because the "hard part" (decoding the encrypted content) is carried by load() function (decoding logic is not shown):
Class MyClass
{
protected $filename, $data;
public function __construct($filename)
{
$this->filename = $filename;
// Create if not exists
if(!file_exists($this->filename))
{
$fp = fopen($this->filename, '');
fclose($fp);
}
$this->load();
}
public function load()
{
$data = file_get_contents($this->filename);
$this->data = $data === false ? array() : $data;
}
}

wb is about all you'd need. Open a file for writing, truncate any file which already exists, set the file pointer to the start of this new file, and enable binary mode (which prevents PHP from translating line-ending characters on certain platforms like Windows).

'a+', here manual. Ensure that permissions for the dir is ok.

Related

How to not have tmpfile() be deleted when out of the scope of the method that it was created by?

I'm on php#8.1.3. When I have one method both creating and reading from a tmpfile, everything works as expected:
class TmpFileReadRightAway
{
public function storeToTempFileAndReadRightAway(string $content): string
{
$fh = tmpfile();
$path = stream_get_meta_data($fh)['uri'];
fwrite($fh, $content);
return file_get_contents($path);
}
}
echo (new TmpFileReadRightAway())->storeToTempFileAndReadRightAway('this works as expected');
Yet when I split the method into multiple methods, the tempfile() is deleted after the method in which it was created returns.
This is not at all what I expected as I wanted to keep the file around. I would expect the tmpfile to be deleted at termination of the php code at the very end, not after it exits the method.
class TmpFileStoreButReadLater
{
public function storeButReadLater(string $content): string
{
$path = $this->getPath($content);
return file_get_contents($path); // file at path doesn't exist anymore here, why?
}
private function getPath($content): string
{
$fh = tmpfile();
$path = stream_get_meta_data($fh)['uri'];
fwrite($fh, $content);
return $path;
}
}
This would throw
PHP Warning: file_get_contents(/tmp/phpQsUdA5): Failed to open stream: No such file or directory
Why is the file being deleted in this case and how do I ensure it exists during the runtime of my code?
Use class property.
The tmpfile() document said.
The file is automatically removed when closed (for example, by calling
fclose(), or when there are no remaining references to the file handle
returned by tmpfile()), or when the script ends.
So, I assume that when method exits, the fclose() is called automatically.
The error about failed to open stream is not just occur in PHP 8.1 but all version since PHP 7.0 to 8.1. (I don't have PHP 5.x to test with.)
To prevent that, set the $fh to class property instead.
class TmpFileStoreButReadLater
{
protected $fh;
public function storeButReadLater(string $content): string
{
$path = $this->getPath($content);
return file_get_contents($path); // file at path doesn't exist anymore here, why?
}
private function getPath($content): string
{
$this->fh = tmpfile();
$path = stream_get_meta_data($this->fh)['uri'];
fwrite($this->fh, $content);
return $path;
}
}
echo (new TmpFileStoreButReadLater())->storeButReadLater('this works as expected');
Tested on PHP 7.0 - 8.1.3 but no errors now.

PHP save Class in other File and call it from another class

Im just tryed to work in PHP how in java, and I got a Problem with save Objects in other php File.
In java will looks like this:
package xxxx
public class Data {
public static Writer writer = null;
}
To save class there?
Data.writer = new Writer(file);
To get it from other Class or use it?
Data.writer.setLine("blablabla");
But when I tryed do the same in PHP there comes Problem then the objects will be not saved in the other file.
My Codes:
ClassErrorLogWriter.php
class ErrorLog {
private $logfile = null;
private $writer = null;
public function __construct($file){
if(file_exists($file)){
$this->logfile = $file;
}else{
$this->logfile = $file;
$this->writer = fopen($this->logfile, "a") or die("Unable to open file! ".$this->logfile);
fwrite($this->writer, "New file was createt\n");
fclose($this->writer);
}
$this->loadWriter();
}
private function loadWriter(){
$this->writer = fopen($this->logfile, "a");
}
public function write($text){
$date = $this->getDataFormat();
fwrite($this->writer, $date.": ".$text."\n");
}
public function writeError($text){
$date = $this->getDataFormat();
fwrite($this->writer, $date.": ERROR: ".$text."\n");
}
private function getDataFormat(){
$date = "".date("d-m-Y_H:i:s A")."";
return $date;
}
public function close(){
fclose($this->writer);
}
}
data.php
$AuctualyPath = null;
$CurrentSqlConnection = null;
$CurrentLogWriter = null;
$DefaultPageFile = "defaultPage/defaultPage.php";
staticFunctions.php
function createFile($file){
$writer = fopen($file, "w");
fclose($writer);
}
function checkFiles(){
if(!file_exists("config.cfg")){
createFile("config.cfg");
$CurrentLogWriter->write("New File config.cfg was createt"); <- Error Here, $CurrentLogWriter is NULL
}
}
Application File (Start) must be called a specific function startSite()
function startSite(){
include "datas/php/ClassErrorLogWriter.php";
include "datas/php/data.php";
include "staticFunctions.php";
echo $DefaultPageFile;
$CurrentLogWriter = new ErrorLog(__DIR__."/logs/logFile.log");
$CurrentLogWriter->writer("test");
checkFiles();
}
After I Included Files I checked first if Data.php Variables are valid with printing $DefaultPageFile, then I defined new Logwriter in the Variable $CurrentLogWriter from Data File tryed to write it (it works). After I called Function from other php Class checkFiles() from staticFunctions.php. in the function checkFiles() by writing the Log It returns me Error then $CurrentLogWriter is NULL.
When I define Data.php as static Class so I must always define this Class and saving from date will not work. Can you help me by this Problem?
The w3school documentation for PHP Variables clearly states:
A variable declared outside a function has a GLOBAL SCOPE and can only be accessed outside a function
When using the include statement, your included file is simply copied as-is into the current file. Therefore, your startfile() is the same as
function startSite(){
include "datas/php/ClassErrorLogWriter.php";
$AuctualyPath = null;
$CurrentSqlConnection = null;
$CurrentLogWriter = null;
$DefaultPageFile = "defaultPage/defaultPage.php";
function createFile($file){
$writer = fopen($file, "w");
fclose($writer);
}
function checkFiles(){
if(!file_exists("config.cfg")){
createFile("config.cfg");
$CurrentLogWriter->write("New File config.cfg was createt"); // <- Error
// Here, $CurrentLogWriter is NULL
}
}
echo $DefaultPageFile;
$CurrentLogWriter = new ErrorLog(__DIR__."/logs/logFile.log");
$CurrentLogWriter->writer("test");
checkFiles();
}
Notice that your $CurrentLogWriter was initialized outside checkFiles() and can only be used within startSite() which is relatively global to checkFile().
A quick solution to this will be to pass $CurrentLogWriter as a parameter to checkFile() like this:
function checkFiles($CurrentLogWriter){
if(!file_exists("config.cfg")){
createFile("config.cfg");
$CurrentLogWriter->write("New File config.cfg was createt"); <- Error
// Here, $CurrentLogWriter is NULL
}
}
OR
You can optionally passed $CurrentLogWriter as a reference parameter, so that you can reuse it:
function checkFiles(&$CurrentLogWriter){
if(!file_exists("config.cfg")){
createFile("config.cfg");
$CurrentLogWriter->write("New File config.cfg was createt"); <- Error
// Here, $CurrentLogWriter is NULL
}
}
Then, call checkFile() as you did, but this time with the parameter
checkFiles($CurrentLogWriter);
How about a simple file_put_contents ?
file_put_contents manual
it looks also you get messed up with fopen and fclose.
i would just collect all lines for such a class file and pump it out in a whole.
It is simple fast and error prune. If file_put_contens not work i would have a look also at the file write permissions.
i think you were confused in File Management (fopen and fclose).
in the checkFiles() function the $CurrentLogWriter variable is a local variable that is not defined anywhere,
you either have to pass that variable as an argument like
function checkFiles($CurrentLogWriter){
if(!file_exists("config.cfg")){
createFile("config.cfg");
$CurrentLogWriter->write("New File config.cfg was createt");
}
}
or define it as a global like so
function checkFiles(){
global $CurrentLogWriter;
if(!file_exists("config.cfg")){
createFile("config.cfg");
$CurrentLogWriter->write("New File config.cfg was createt");
}
}
and of course also define the global in the function where the vairable is created
function startSite(){
global $CurrentLogWriter;
...
$CurrentLogWriter = new ErrorLog(__DIR__."/logs/logFile.log");
...
}

Save file to memory and later write back

I wish to read a file using PHP, and later write it to a directory which doesn't exist at the time of reading the file. I can't create the directory first as described below. I do not wish to save it in a temporary directory to prevent possible overwrites. Am I able to read the file, save it in memory, and later write the file?
WHY I WISH TO DO THIS: I have the following method which empties a directory. I now have a need to do so but keep one file in the root of the emptied directory. I recognize I could modify this method to do so, but I rarely need to do so, and may wish another approach. Instead, before calling this method, I would like to copy the file in question, empty the directory, and then put it back.
/**
* Empty directory. Include subdirectories if $deep is true
*/
public static function emptyDir($dirname,$deep=false)
{
$dirname=(substr($dirname, -1)=='/')?$dirname:$dirname.'/';
if(!is_dir($dirname)){return false;}
// Loop through the folder
$dir = dir($dirname);
while (false !== $entry = $dir->read())
{
// Skip pointers
if ($entry == '.' || $entry == '..') {
continue;
}
elseif(is_file($dirname.$entry)) {
unlink($dirname.$entry);
}
elseif($deep && is_dir($dirname.$entry)){
self::deltree($dirname.$entry);
}
}
// Clean up
$dir->close();
return true;
}
Provided this is all done withing the same request, then yes you can.
Just save the file contents to a variable, then write it back again:
$temp = file_get_contents('path/to/file.ext');
className::emptyDir($dir);
file_put_contents('path/to/file.ext', $temp);
Yes, it could be done. Just add a property to your class. So in your class property, there will be the content of the file, while the object is exists, and it did set. It could be a class variable (static) also, so you do not need to instantiate if you do not want.
class anything {
var $fileContent = '';
public static function emptyDir($dirname,$deep=false) {
//....
}
public function setFileContent($fileOrUrlToRead) {
$this->fileContent = file_get_contents($fileOrUrlToRead);
}
public function saveFile($fileName) {
file_put_contents($fileName, $this->fileContent);
}
}
$anything = new anything();
$anything->setFileContent('url_or_path_of_file_to_get');
anything::emptyDir('./media/files/');
$anything->saveFile('./media/files/something.txt');
You can use the session to save the needed information.

Multithreaded File Processing in PHP with pthreads

I'm trying to create a script that process a number of files simultanously, the rule is, each file can only be processed once, and the input file is deleted after it has been processed. I created this script :
<?php
// Libraries for reading files
require_once "spooler.php";
// Configuration section ///////////////////////////////////////////////////////
$config["data"] = "data";
$config["threads"] = 20;
$config["timer"] = 1;
// Array to store currently processed files
$config["processed_files"] = array();
// Processing section //////////////////////////////////////////////////////////
$timer = 0;
$pool = new Pool($config["threads"], \ProcessingWorker::class);
while (true) {
// Read a number of files from the data folder according to the number of thread
$files = Spooler::read_spool_file($config["data"], $config["threads"]);
foreach ($files as $file) {
// Check if the file is already processed
if (in_array($file, $config["processed_files"])) continue;
// Submit the file to the worker
echo "Submitting $file\n";
$config["processed_files"][$file] = $file;
$pool->submit(new ProcessingJob($config, $file));
}
sleep($config["timer"]);
$timer++;
}
$pool->shutdown();
// Processing thread section ///////////////////////////////////////////////////
class ProcessingJob extends Stackable {
private $config;
private $file;
public function __construct($config, $file)
{
$this->config = $config;
$this->file = $file;
$this->complete = false;
}
public function run()
{
echo "Processing $this->file\n";
// Pretend we're doing something that takes time
sleep(mt_rand(1, 10));
file_put_contents("_LOG", $this->file."\n", FILE_APPEND);
// Delete the file
#unlink($this->file);
// Remove the file from the currently processing list
unset($this->config["processed_files"][$this->file]);
}
}
class ProcessingWorker extends Worker {
public function run() {}
}
However, this code doesn't work well, it doesn't process the same files twice, but instead sometimes it skip processing some files. Here's the file list it should be processed, but it only process these files.
Where am I doing it wrong?
Output to the log file isn't synchronized, it's highly likely that two threads are concurrently calling file_put_contents on the log file and so corrupting it's output.
You should not write to a log file in this way.
If $config['processed_files'] is intended to be manipulated by multiple contexts then it should be a thread safe structure descended from pthreads, not a plain PHP array.

PHP Counter Using OOP

I'm new to OOP terminology, I am trying to create a class that make a hit counter.
I try the code below but it create just a counter.txt page with inside value 1. I dont know why its not incrementing.
class LOGFILE {
public function READ($FileName) {
$handle = fopen($FileName, 'r');
$fread = file_get_contents($FileName);
return $fread;
fclose($handle);
}
public function WRITE($FileName, $FileData) {
$handle = fopen($FileName, 'w');
$FileData = $fread +1;
fwrite($handle, $FileData);
fclose($handle);
}
}
$logfile = new LOGFILE();
$logfile -> WRITE("counter.txt",$FileData);
echo $logfile -> READ("counter.txt");
The reason is that $fread is local variable for both READ and WRITE methods. You need to make it private global variable for your class:
class LOGFILE {
private $fread;
public function READ($FileName) {
$this->fread = file_get_contents($FileName);
return $this->fread;
}
public function WRITE($FileName) {
$this->READ($FileName);
$handle = fopen($FileName, 'w');
$FileData = $this->fread +1;
fwrite($handle, $FileData);
fclose($handle);
}
}
$logfile = new LOGFILE();
$logfile -> WRITE("counter.txt");
echo $logfile -> READ("counter.txt");
Note: I have removed fopen and fclose because file_get_contents does not need it. In write you can use file_put_contents. Removed not used variable $FileData too. It's always a good practice to create variables methods and classes when they are needed.
Also take a look at best practices how to name your classes, variables, methods and so on. Here's best guide, IMO.
Let's start going over the corrected code and see what was missing:
<?php
class LOGFILE {
public function READ($FileName) {
$handle = fopen($FileName, 'r');
$fread = fgets($handle, 8192);
fclose($handle);
return $fread;
}
public function WRITE($FileName, $FileData) {
$counter = $this->READ($FileName);
$handle = fopen($FileName, 'w');
fwrite($handle, $FileData + $counter);
fclose($handle);
}
}
$logfile = new LOGFILE();
$FileData = 1;
$logfile -> WRITE("counter.txt",$FileData);
echo $logfile -> READ("counter.txt")."\n";
$logfile -> WRITE("counter.txt",$FileData);
echo $logfile -> READ("counter.txt")."\n";
?>
use of fgets instead of file_get_contents in READ (you can choose to use file_get_contents but I rather stay consistent with the other function that uses fopen)
use of READ inside function WRITE (the principal of code-reuse)
open of file with write permissions in WRITE: 'w'
init $FileData = 1;
no need to hold a private member: $fread
most important: do not write statements after return (like you did in READ) - statements that are written after return will not be executed!
This solution was tested successfully.
OOP must be used where it's needed. You need a simple thing so, no need of OOP.
<?php
function addValue($file='counter.txt', $amount=1) {
if( false == is_file($file) ) {
return false;
}
$initial = file_get_contents($file);
return #file_put_contents($initial+$amount);
}
addValue();
?>
Test your OOP knowledge on something complex, like a shopping cart or some other concept.
EDIT // so, if you need a simple example that looks complex, here you go :)
<?php
class log {
public $file = '';
private $amount = 0;
public function __construct( $file ) {
$this->file = $file;
$this->amount = 1;
}
public function makeAdd() {
$initial = file_get_contents($this->file);
return #file_put_contents($this->file, $initial + $this->amount);
}
function __call($f, $args) {
switch( $f ) {
case 'add':
if(isset($args[0]) && !empty($args[0])) {
$this->amount = (int)$args[0];
}
if( $this->amount == 0 ) {
throw new Exception('Not a valid amount.');
}
return $this->makeAdd();
break;
}
}
}
try {
// create log
$L = new log('count.txt');
// this will add 2
var_dump($L->add(2));
// this will also add 2
var_dump($L->add());
// until you rewrite the amount
var_dump($L->add(1));
// final result -> 5
} catch(Exception $e) {
die($e->getMessage());
}
?>
Good luck!
Use UpperCamelCase for class names. LogFile, not LOGFILE. When you have a variable and the most interesting thing about it is that it's expected to hold a reference to something that is_a LogFile you should name it logFile.
Use lowerCamelCase for functions. read and write, not READ and WRITE
No spaces around the arrow operator
Code after a return statement in a method can never be reached, so delete it.
read() does not use the handle returned by fopen, so don't call fopen
the temp variable $freed doesn't help us understand the code, so we can lose it
read is a slightly unconventional name. If we rename the function to getCount it will be more obvious what it does.
You said you wanted to make a hit counter. So rename the class from LogFile to HitCounter, and the variable to hitCounter
the $FileData parameter to write doesn't get used because the variable is re-assigned inside the function. We can lose it.
The write method is supposed to add one to the number in the file. Write doesn't really express that. Rename it to increment.
Use a blank line between functions. The procedural code at the end should generally be in a separate file, but here we can just add a couple of extra lines. Delete the blanks between the last three lines of code.
Don't repeat yourself - we shouldn't have to mention 'counter.txt' more than once. OOP is all about combining data structures and behaviour into classes, so make a class private variable to hold the filename, and pass it via a constructor
$fread doesn't exist in the scope of increment, so we can't use it. This won't work. Replace it with a call to to getCount()
Swap the first two lines of increment, so we're not doing two concurent accesses to the same file, although we might be running inside a server that's running our script twice and still doing two concurrent accesses.
Rename the variable $FileData to $count, since that's what it is.
Replace the fopen,fwrite,fclose sequence with file_put_contents, since that does the same thing and is more succinct.
We need tag, since our php code continues to the end of the file.
That leaves us with:
<?php
class HitCounter {
private $fileName;
public function __construct($fileName){
$this->fileName = $fileName;
}
public function getCount() {
return file_get_contents($this->fileName);
}
public function increment() {
$count = $this->getCount() + 1;
file_put_contents($this->fileName, $count);
}
}
$hitCounter = new HitCounter("counter.txt");
$hitCounter->increment();
echo $hitCounter->getCount();
You can create a static counter and increment it each time (instead of create file)
<?php
class CountClass {
public static $counter = 0;
function __construct() {
self::$counter++;
}
}
new CountClass();
new CountClass();
echo CountClass::$counter;
?>

Categories