ChatGPT解决这个技术问题 Extra ChatGPT

How do I check if file exists in jQuery or pure JavaScript?

How do I check if a file on my server exists in jQuery or pure JavaScript?


S
Spiralis

With jQuery:

$.ajax({
    url:'http://www.example.com/somefile.ext',
    type:'HEAD',
    error: function()
    {
        //file not exists
    },
    success: function()
    {
        //file exists
    }
});

EDIT:

Here is the code for checking 404 status, without using jQuery

function UrlExists(url)
{
    var http = new XMLHttpRequest();
    http.open('HEAD', url, false);
    http.send();
    return http.status!=404;
}

Small changes and it could check for status HTTP status code 200 (success), instead.

EDIT 2: Since sync XMLHttpRequest is deprecated, you can add a utility method like this to do it async:

function executeIfFileExist(src, callback) {
    var xhr = new XMLHttpRequest()
    xhr.onreadystatechange = function() {
        if (this.readyState === this.DONE) {
            callback()
        }
    }
    xhr.open('HEAD', src)
}

in your pure javascript example you should be binding OnReadyStateChange event before you check the HTTP_STATUS.
The example code is wrong, and there's nothing whatsoever said about what's going on at the server. The original question is pretty vague, but there's no reason to assume that the server that's running there is in fact mapping URLs directly to the file system. Honestly, I don't see why this answer is so popular as it doesn't really say how to do what the question asked for.
@Pointy Could be because it resolves something the rest of us are Googling for
@cichy - does this load the file into memory or not? I'm looking to check for existence but not load a file.
Synchronous XMLHttpRequest on the main thread is deprecated because of its detrimental effects to the end user's experience. For more help xhr.spec.whatwg.org (This warning by browser)
M
Matthew James Davis

A similar and more up-to-date approach.

$.get(url)
    .done(function() { 
        // exists code 
    }).fail(function() { 
        // not exists code
    })

why is this more up-to-date? $.ajax seems better if it is more backward compatible, right?
$.ajax works too, but success/error/complete functions are deprecated in favor of promises, done/fail/always methods. read more about it here api.jquery.com/jQuery.ajax. I used get here because we're only interested in a simple get, but this is just shorthand for $.ajax({url:url,type:'GET'}).
If the image doesn't exist, the console echo's a 404 error. Is there a way to remove this, because my application is always expecting one image to not exist...
Not possible, see: stackoverflow.com/a/16379746/1981050. However, this should not interrupt your behavior. It will just yield some extraneous logging.
cross origin issues are unrelated to this
T
Tester

This works for me:

function ImageExist(url) 
{
   var img = new Image();
   img.src = url;
   return img.height != 0;
}

While some other answers are better for their function, I +1 this answer as it is what i was looking for. Just remember, you will always get zero unless you load the content first!. ie: window.addEventListener('load', function(){
Actually, I still had issues, even with the window load. Seems like the image cannot be measured until it is cached somehow. Anyway, I doesn't work for me on first time load of the page. (ie: user has never seen this image before). It might work for you if you have the image on a previous page, maybe...
That's because it sets the source of the image and IMMEDIATELY checks to see the height of the image which has not finished downloading yet. You'd have to add an onload handler for this to work. This is not a reliable approach for that exact reason.
Why isn't it reliable if you add an img.onload hanlder like so stackoverflow.com/a/12355031/988591 ?
The question asks about a file, not an image! If the URL does exist and is not a file its height will be 0!!
G
Gino

i used this script to add alternative image

function imgError()
{
alert('The image could not be loaded.');
}

HTML:

<img src="image.gif" onerror="imgError()" />

http://wap.w3schools.com/jsref/event_onerror.asp


Great -- didn't know that. You can do the following to set a save alternative if an image does not exist:
@Ridcully Ah, but what if the alternative fails? Then you're in an endless loop right?
If the alternative fails, i suppose there's something more wrong on the server side (or on the programmer's side :P)
You could always set the OnError of the img tag to nothing when setting the alt image to prevent the endless loop.
Bad news from the future. This is marked as "Deprecated. Not for use in new websites." developer.mozilla.org/en-US/docs/Web/HTML/Element/img
Y
YemSalat

So long as you're testing files on the same domain this should work:

function fileExists(url) {
    if(url){
        var req = new XMLHttpRequest();
        req.open('GET', url, false);
        req.send();
        return req.status==200;
    } else {
        return false;
    }
}

Please note, this example is using a GET request, which besides getting the headers (all you need to check weather the file exists) gets the whole file. If the file is big enough this method can take a while to complete.

The better way to do this would be changing this line: req.open('GET', url, false); to req.open('HEAD', url, false);


Sorry, this is effectively the same as the accepted answer. Ignore me.
its some more details on the non-jQuery form which can be helpful
@Moob, its not "effectively the same as the accepted answer", you're sending a GET request, which is way different to HEAD request.
async: false, synchronous operation in Firefox version 30.0 and later, and in recent/current versions of Chrome is deprecated due to unfavorable user experience. Attempted use results in fail/error. Should use async: true with callback function for asynchronous operation.
Please this wait for response before continue to execute further JS? Thank you.
N
Nik Sumeiko

Here's how to do it ES7 way, if you're using Babel transpiler or Typescript 2:

async function isUrlFound(url) {
  try {
    const response = await fetch(url, {
      method: 'HEAD',
      cache: 'no-cache'
    });

    return response.status === 200;

  } catch(error) {
    // console.log(error);
    return false;
  }
}

Then inside your other async scope, you can easily check whether url exist:

const isValidUrl = await isUrlFound('http://www.example.com/somefile.ext');

console.log(isValidUrl); // true || false

S
Shaun

I was getting a cross domain permissions issue when trying to run the answer to this question so I went with:

function UrlExists(url) {
$('<img src="'+ url +'">').load(function() {
    return true;
}).bind('error', function() {
    return false;
});
}

It seems to work great, hope this helps someone!


I think this will lose the boolean values because they get returned from the callbacks, not the UrlExists function.
this can't work, you should read this : stackoverflow.com/questions/14220321/…
how the url looks? , with extension or without extension?
J
Jan Turoň

All other answers can fail due to cache!

Making a HTTP request to a file on the server can be intercepted with browser's cache and the cached response is then returned. But the file may be deleted on the server in the meantime, so ignoring cache may return false positive results.

Proper solution would be to create non-cached HTTP HEAD request. Nik Sumeiko's answer uses no-cache header which means that the response can be cached, but must be revalidated before reuse. In this case the server may return 304: Not Modified, which is not 200: OK and thus false negative.

To avoid cache, the correct header is Cache-Control: no-store

File can exist without HTTP 200 response

You should also keep in mind that redirection (301: Moved Permanently, 307: Temporary Redirect or 308: Permanent Redirect) may occur, so the file can exist elsewhere and may be returned from different location: depending on the use-case, one may choose to follow redirection instead of returning false in this case.

Also keep in mind that background requests will be blocked if you check file existence on different domain and its CORS policy is not opened to your server. In this case 403: Forbidden is usually returned, which doesn't mean file does not exist but file is unavailable. Last but not least, the same applies to 500: Internal Server Error response, which means that the HTTP server failed to handle the request, but the file can be available otherwise, like by FTP.

The following code will return true if the file exists, false if not or undefined if the file is unavailable or redirected:

const fileExists = file =>
  fetch(file, {method: 'HEAD', cache: 'no-store'})
  .then(response => ({200: true, 404: false})[response.status])
  .catch(e => undefined);

fileExists("yourFile.html").then(yes => yes && alert("yourFile.html exists"));

// if not in the main thread...
let yourFileExists = await fileExists("yourFile.html");

Modern and obsolete approaches

Since we live in the future now, I would also recommend:

$.ajax() obsolete, don't use in new projects

XMLHttpRequest() obsolete, don't use in new projects

fetch() modern approach, use it if you are free to choose

GET/POST methods (like <img src...>) are not appropriate here as they waste network traffic by downloading the file (imagine scenario with high resolution photo and user with paid mobile data in area with poor connection)


Great code -- note that if you want to use this method on major android mobile browsers, only 2022 browser updates can handle it. You may want to check if 'fetch' exists (detect to use older methods if needed) in order to include those. See caniuse.com/fetch
G
Gëzim Musliaj

I use this script to check if a file exists (also it handles the cross origin issue):

$.ajax(url, {
       method: 'GET',
       dataType: 'jsonp'
         })
   .done(function(response) { 
        // exists code 
    }).fail(function(response) { 
        // doesnt exist
    })

Note that the following syntax error is thrown when the file being checked doesn't contain JSON.

Uncaught SyntaxError: Unexpected token <


s
sashkello

For a client computer this can be achieved by:

try
{
  var myObject, f;
  myObject = new ActiveXObject("Scripting.FileSystemObject");
  f =   myObject.GetFile("C:\\img.txt");
  f.Move("E:\\jarvis\\Images\\");
}
catch(err)
{
  alert("file does not exist")
}

This is my program to transfer a file to a specific location and shows alert if it does not exist


If you're going to use FileSystemObject it seems easier to use the FileExists() method. msdn.microsoft.com/en-us/library/aa265024(v=vs.60).aspx
ActiveXObject is only available in Internet Explorer, so this won't work in other browsers.
A
Ani Menon

JavaScript function to check if a file exists:

function doesFileExist(urlToFile)
{
    var xhr = new XMLHttpRequest();
    xhr.open('HEAD', urlToFile, false);
    xhr.send();

    if (xhr.status == "404") {
        console.log("File doesn't exist");
        return false;
    } else {
        console.log("File exists");
        return true;
    }
}

This is the simplest working answer. Also it does not need async.
J
Jim Bergman

An async call to see if a file exists is the better approach, because it doesn't degrade the user experience by waiting for a response from the server. If you make a call to .open with the third parameter set to false (as in many examples above, for example http.open('HEAD', url, false); ), this is a synchronous call, and you get a warning in the browser console.

A better approach is:

function fetchStatus( address ) {
  var client = new XMLHttpRequest();
  client.onload = function() {
    // in case of network errors this might not give reliable results
    returnStatus( this.status );
  }
  client.open( "HEAD", address, true );
  client.send();
}

function returnStatus( status ) {
  if ( status === 200 ) {
    console.log( 'file exists!' );
  }
  else {
    console.log( 'file does not exist! status: ' + status );
  }
}

source: https://xhr.spec.whatwg.org/


I also get a warning response in the console log with your method, any idea ?
Try calling .open with the third parameter set to true to make sure it calls it asynchronously, like this client.open("HEAD", address, true); @Pierre
J
Josh Harris

This is an adaptation to the accepted answer, but I couldn't get what I needed from the answer, and had to test this worked as it was a hunch, so i'm putting my solution up here.

We needed to verify a local file existed, and only allow the file (a PDF) to open if it existed. If you omit the URL of the website, the browser will automatically determine the host name - making it work in localhost and on the server:

$.ajax({

    url: 'YourFolderOnWebsite/' + SomeDynamicVariable + '.pdf',
    type: 'HEAD',
    error: function () {
        //file not exists
        alert('PDF does not exist');

    },
    success: function () {
        //file exists
        window.open('YourFolderOnWebsite/' + SomeDynamicVariable + '.pdf', "_blank", "fullscreen=yes");

    }
});

V
Vladimir Salguero

First creates the function

$.UrlExists = function(url) { var http = new XMLHttpRequest(); http.open('HEAD', url, false); http.send(); return http.status!=404; }

After using the function as follows

if($.UrlExists("urlimg")){ foto = "img1.jpg"; }else{ foto = "img2.jpg"; } $('').attr('src',foto);


I tried here but could not get it work. What I have been missing?
b
blissweb

Here's my working Async Pure Javascript from 2020

function testFileExists(src, successFunc, failFunc) {
    var xhr = new XMLHttpRequest();
    xhr.onreadystatechange = function () {
        if (this.readyState === this.DONE) {
            if (xhr.status === 200) {
                successFunc(xhr);
            } else {
                failFunc(xhr);
            }
        }
    }
    // xhr.error = function() {
    //     failFunc(xhr);
    // }
    // xhr.onabort = function() {
    //     failFunc(xhr);
    // }
    // xhr.timeout = function() {
    //     failFunc(xhr);
    // }
    xhr.timeout = 5000;           // TIMEOUT SET TO PREFERENCE (5 SEC)
    xhr.open('HEAD', src, true);
    xhr.send(null);               // VERY IMPORTANT
}
function fileExists(xhr) {
    alert("File exists !!  Yay !!");
}
function fileNotFound(xhr) {
    alert("Cannot find the file, bummer");
}
testFileExists("test.html", fileExists, fileNotFound);

I could not force it to come back with any of the abort, error, or timeout callbacks. Each one of these returned a main status code of 0, in the test above, so I removed them. You can experiment. I set the timeout to 5 seconds as the default seems to be very excessive. With the Async call, it doesn't seem to do anything without the send() command.


M
MadcapLaugher

What you'd have to do is send a request to the server for it to do the check, and then send back the result to you.

What type of server are you trying to communicate with? You may need to write a small service to respond to the request.


t
timgavin

This doesn't address the OP's question, but for anyone who is returning results from a database: here's a simple method I used.

If the user didn't upload an avatar the avatar field would be NULL, so I'd insert a default avatar image from the img directory.

function getAvatar(avatar) {
    if(avatar == null) {
        return '/img/avatar.jpg';
    } else {
        return '/avi/' + avatar;
    }
}

then

<img src="' + getAvatar(data.user.avatar) + '" alt="">

A
AnhMV

It works for me, use iframe to ignore browsers show GET error message

 var imgFrame = $('<iframe><img src="' + path + '" /></iframe>');
 if ($(imgFrame).find('img').attr('width') > 0) {
     // do something
 } else {
     // do something
 }

G
Gianlorenzo Lenza

I wanted a function that would return a boolean, I encountered problems related to closure and asynchronicity. I solved this way:

checkFileExistence= function (file){
    result=false;
    jQuery.ajaxSetup({async:false});
    $.get(file)
        .done(function() {
           result=true;
        })
        .fail(function() {
           result=false;
        })
    jQuery.ajaxSetup({async:true});
    return(result);
},

Still can not manage properly detect file existence without using jQuery. I tried all approaches listed above. Status always 200, regardless file existence.
A
Arash

You can use this command, I use that for my website.

if (File("patch").exists)
{
    //do jobe when exists
} else {
    // do jobe when dosent exist
}

thanks


What is File? What is exists?
File is an module and exists is bool.